From 09621f0155063438ef4902470484345d9d58faff Mon Sep 17 00:00:00 2001 From: Alan Knowles Date: Thu, 29 Jul 2021 17:23:34 +0800 Subject: [PATCH] sync --- Roo/bootstrap/menu/depricated.js | 5 + Roo/bootstrap/nav/Bar.js | 172 +++ Roo/bootstrap/nav/Group.js | 300 ++++ Roo/bootstrap/nav/Headerbar.js | 188 +++ Roo/bootstrap/nav/Item.js | 379 +++++ Roo/bootstrap/nav/ProgressBar.js | 252 ++++ Roo/bootstrap/nav/ProgressBarItem.js | 152 ++ Roo/bootstrap/nav/Sidebar.js | 47 + Roo/bootstrap/nav/SidebarItem.js | 228 +++ Roo/bootstrap/nav/Simplebar.js | 129 ++ Roo/bootstrap/nav/depricated.js | 13 + .../src/Roo_bootstrap_menu_depricated.js.html | 6 + docs/src/Roo_bootstrap_nav_Bar.js.html | 172 +++ docs/src/Roo_bootstrap_nav_Group.js.html | 300 ++++ docs/src/Roo_bootstrap_nav_Headerbar.js.html | 188 +++ docs/src/Roo_bootstrap_nav_Item.js.html | 379 +++++ .../src/Roo_bootstrap_nav_ProgressBar.js.html | 253 ++++ .../Roo_bootstrap_nav_ProgressBarItem.js.html | 152 ++ docs/src/Roo_bootstrap_nav_Sidebar.js.html | 47 + .../src/Roo_bootstrap_nav_SidebarItem.js.html | 228 +++ docs/src/Roo_bootstrap_nav_Simplebar.js.html | 129 ++ docs/src/Roo_bootstrap_nav_depricated.js.html | 13 + docs/src/Roo_bootstrap_nav_namespace.js.html | 3 + docs/symbols/Roo.bootstrap.nav.Bar.json | 1145 ++++++++++++++ docs/symbols/Roo.bootstrap.nav.Group.json | 1317 +++++++++++++++++ docs/symbols/Roo.bootstrap.nav.Headerbar.json | 1231 +++++++++++++++ docs/symbols/Roo.bootstrap.nav.Item.json | 1289 ++++++++++++++++ .../Roo.bootstrap.nav.ProgressBar.json | 1119 ++++++++++++++ .../Roo.bootstrap.nav.ProgressBarItem.json | 1143 ++++++++++++++ docs/symbols/Roo.bootstrap.nav.Sidebar.json | 28 + .../Roo.bootstrap.nav.SidebarItem.json | 1288 ++++++++++++++++ docs/symbols/Roo.bootstrap.nav.Simplebar.json | 1193 +++++++++++++++ docs/symbols/Roo.bootstrap.nav.json | 21 + 33 files changed, 13509 insertions(+) create mode 100644 Roo/bootstrap/menu/depricated.js create mode 100644 Roo/bootstrap/nav/Bar.js create mode 100644 Roo/bootstrap/nav/Group.js create mode 100644 Roo/bootstrap/nav/Headerbar.js create mode 100644 Roo/bootstrap/nav/Item.js create mode 100644 Roo/bootstrap/nav/ProgressBar.js create mode 100644 Roo/bootstrap/nav/ProgressBarItem.js create mode 100644 Roo/bootstrap/nav/Sidebar.js create mode 100644 Roo/bootstrap/nav/SidebarItem.js create mode 100644 Roo/bootstrap/nav/Simplebar.js create mode 100644 Roo/bootstrap/nav/depricated.js create mode 100644 docs/src/Roo_bootstrap_menu_depricated.js.html create mode 100644 docs/src/Roo_bootstrap_nav_Bar.js.html create mode 100644 docs/src/Roo_bootstrap_nav_Group.js.html create mode 100644 docs/src/Roo_bootstrap_nav_Headerbar.js.html create mode 100644 docs/src/Roo_bootstrap_nav_Item.js.html create mode 100644 docs/src/Roo_bootstrap_nav_ProgressBar.js.html create mode 100644 docs/src/Roo_bootstrap_nav_ProgressBarItem.js.html create mode 100644 docs/src/Roo_bootstrap_nav_Sidebar.js.html create mode 100644 docs/src/Roo_bootstrap_nav_SidebarItem.js.html create mode 100644 docs/src/Roo_bootstrap_nav_Simplebar.js.html create mode 100644 docs/src/Roo_bootstrap_nav_depricated.js.html create mode 100644 docs/src/Roo_bootstrap_nav_namespace.js.html create mode 100644 docs/symbols/Roo.bootstrap.nav.Bar.json create mode 100644 docs/symbols/Roo.bootstrap.nav.Group.json create mode 100644 docs/symbols/Roo.bootstrap.nav.Headerbar.json create mode 100644 docs/symbols/Roo.bootstrap.nav.Item.json create mode 100644 docs/symbols/Roo.bootstrap.nav.ProgressBar.json create mode 100644 docs/symbols/Roo.bootstrap.nav.ProgressBarItem.json create mode 100644 docs/symbols/Roo.bootstrap.nav.Sidebar.json create mode 100644 docs/symbols/Roo.bootstrap.nav.SidebarItem.json create mode 100644 docs/symbols/Roo.bootstrap.nav.Simplebar.json create mode 100644 docs/symbols/Roo.bootstrap.nav.json diff --git a/Roo/bootstrap/menu/depricated.js b/Roo/bootstrap/menu/depricated.js new file mode 100644 index 0000000000..ef570462ce --- /dev/null +++ b/Roo/bootstrap/menu/depricated.js @@ -0,0 +1,5 @@ +// deprciated +Roo.bootstrap.Menu = Roo.bootstrap.menu.Menu; +Roo.bootstrap.MenuItem = Roo.bootstrap.menu.Item; +Roo.bootstrap.MenuSeparator = Roo.bootstrap.menu.Separator + diff --git a/Roo/bootstrap/nav/Bar.js b/Roo/bootstrap/nav/Bar.js new file mode 100644 index 0000000000..6b2d9d7363 --- /dev/null +++ b/Roo/bootstrap/nav/Bar.js @@ -0,0 +1,172 @@ +/* + * - LGPL + * + * navbar + * + */ + +/** + * @class Roo.bootstrap.nav.Bar + * @extends Roo.bootstrap.Component + * @abstract + * Bootstrap Navbar class + + * @constructor + * Create a new Navbar + * @param {Object} config The config object + */ + + +Roo.bootstrap.nav.Bar = function(config){ + Roo.bootstrap.nav.Bar.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.nav.Bar, 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', this.onToggle , 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(); + }, + onToggle : function() + { + + if(this.fireEvent('beforetoggle', this) === false){ + return; + } + var ce = this.el.select('.navbar-collapse',true).first(); + + if (!ce.hasClass('show')) { + this.expand(); + } else { + this.collapse(); + } + + + + }, + /** + * Expand the navbar pulldown + */ + expand : function () + { + + var ce = this.el.select('.navbar-collapse',true).first(); + if (ce.hasClass('collapsing')) { + return; + } + ce.dom.style.height = ''; + // show it... + ce.addClass('in'); // old... + 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); + ce.dom.scrollTop = 0; + }, + /** + * Collapse the navbar pulldown + */ + collapse : function() + { + var ce = this.el.select('.navbar-collapse',true).first(); + + if (ce.hasClass('collapsing') || ce.hasClass('collapse') ) { + // it's collapsed or collapsing.. + return; + } + ce.removeClass('in'); // old... + 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); + } + + + +}); + + + + + + \ No newline at end of file diff --git a/Roo/bootstrap/nav/Group.js b/Roo/bootstrap/nav/Group.js new file mode 100644 index 0000000000..9167d47263 --- /dev/null +++ b/Roo/bootstrap/nav/Group.js @@ -0,0 +1,300 @@ +/* + * - LGPL + * + * nav group + * + */ + +/** + * @class Roo.bootstrap.nav.Group + * @extends Roo.bootstrap.Component + * @children Roo.bootstrap.nav.Item + * 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. + * @cfg {Boolean} pilltype default true (turn to off to disable active toggle) + * + * @constructor + * Create a new nav group + * @param {Object} config The config object + */ + +Roo.bootstrap.nav.Group = function(config){ + Roo.bootstrap.nav.Group.superclass.constructor.call(this, config); + this.navItems = []; + + Roo.bootstrap.nav.Group.register(this); + this.addEvents({ + /** + * @event changed + * Fires when the active item changes + * @param {Roo.bootstrap.nav.Group} 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.nav.Group, Roo.bootstrap.Component, { + + align: '', + inverse: false, + form: false, + type: 'nav', + navId : '', + // private + pilltype : true, + + navItems : false, + + getAutoCreate : function() + { + var cfg = Roo.apply({}, Roo.bootstrap.nav.Group.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 { + // trying to remove so header bar can right align top? + if (this.parent() && this.parent().xtype != 'NavHeaderbar') { + // do not use on header bar... + 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' + }; + //nav navbar-right ml-md-auto + 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.nav.Item} 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.nav.Item} 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.nav.Item} the navitem to add + */ + addItem : function(cfg) + { + if (this.form && Roo.bootstrap.version == 4) { + cfg.tag = 'div'; + } + var cn = new Roo.bootstrap.nav.Item(cfg); + this.register(cn); + cn.parentId = this.id; + cn.onRender(this.el, null); + return cn; + }, + /** + * register a Navigation item + * @param {Roo.bootstrap.nav.Item} 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.nav.Group, { + + groups: {}, + /** + * register a Navigation Group + * @param {Roo.bootstrap.nav.Group} 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.nav.Group} the navgroup + */ + get: function(navId) { + if (typeof(this.groups[navId]) == 'undefined') { + return false; + //this.register(new Roo.bootstrap.nav.Group({ navId : navId })); + } + return this.groups[navId] ; + } + + + +}); + + \ No newline at end of file diff --git a/Roo/bootstrap/nav/Headerbar.js b/Roo/bootstrap/nav/Headerbar.js new file mode 100644 index 0000000000..2a72dba8bd --- /dev/null +++ b/Roo/bootstrap/nav/Headerbar.js @@ -0,0 +1,188 @@ +/* + * - LGPL + * + * navbar + * navbar-fixed-top + * navbar-expand-md fixed-top + */ + +/** + * @class Roo.bootstrap.nav.Headerbar + * @extends Roo.bootstrap.nav.Simplebar + * @children Roo.bootstrap.nav.Group Roo.bootstrap.Container Roo.bootstrap.Form Roo.bootstrap.Row Roo.bootstrap.Column Roo.bootstrap.Link + * 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.nav.Headerbar = function(config){ + Roo.bootstrap.nav.Headerbar.superclass.constructor.call(this, config); + +}; + +Roo.extend(Roo.bootstrap.nav.Headerbar, Roo.bootstrap.nav.Simplebar, { + + 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: Roo.bootstrap.version == 4 ? 'nav flex-row roo-navbar-collapse collapse navbar-collapse' : 'collapse navbar-collapse roo-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(); + }, + + getChildContainer : function() + { + + return this.el.select('.roo-navbar-collapse',true).first(); + + + }, + + initEvents : function() + { + Roo.bootstrap.nav.Headerbar.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/Roo/bootstrap/nav/Item.js b/Roo/bootstrap/nav/Item.js new file mode 100644 index 0000000000..de57df3324 --- /dev/null +++ b/Roo/bootstrap/nav/Item.js @@ -0,0 +1,379 @@ +/** + * @class Roo.bootstrap.nav.Item + * @extends Roo.bootstrap.Component + * @children Roo.bootstrap.Container Roo.bootstrap.Button + * @licence LGPL + * Bootstrap Navbar.NavItem class + * + * @cfg {String} href link to + * @cfg {String} button_weight (default|primary|secondary|success|info|warning|danger|link|light|dark) default none + * @cfg {Boolean} button_outline show and outlined button + * @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 {String} linkcls Link Class + * @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 + * @cfg {Roo.bootstrap.menu.Menu} menu a Menu + + * @constructor + * Create a new Navbar Item + * @param {Object} config The config object + */ +Roo.bootstrap.nav.Item = function(config){ + Roo.bootstrap.nav.Item.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.nav.Item} this + * @param {boolean} state the new state + + */ + 'changed': true, + /** + * @event scrollto + * Fires when scroll to element + * @param {Roo.bootstrap.nav.Item} this + * @param {Object} options + * @param {Roo.EventObject} e + + */ + 'scrollto': true + }); + +}; + +Roo.extend(Roo.bootstrap.nav.Item, 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, + linkcls : '', + navLink: false, + + getAutoCreate : function(){ + + var cfg = { + tag: this.tag, + cls: 'nav-item' + }; + + cfg.cls = typeof(cfg.cls) == 'undefined' ? '' : cfg.cls; + + if (this.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 = ' ' + this.html + ''; + } else { + cfg.cls += " nav-html"; + } + + // menu .. should add dropdown-menu class - so no need for carat.. + + if (this.badge !== '') { + + cfg.html += ' ' + this.badge + ''; + } + return cfg; + } + + if (this.href || this.html || this.glyphicon || this.icon || this.fa) { + cfg.cn = [ + { + tag: this.tagtype, + href : this.href || "#", + html: this.html || '', + cls : '' + } + ]; + if (this.tagtype == 'a') { + cfg.cn[0].cls = 'nav-link' + (this.active ? ' active' : '') + ' ' + this.linkcls; + + } + if (this.icon) { + cfg.cn[0].html = ' ' + cfg.cn[0].html + ''; + } else if (this.fa) { + cfg.cn[0].html = ' ' + cfg.cn[0].html + ''; + } else if(this.glyphicon) { + cfg.cn[0].html = ' ' + cfg.cn[0].html; + } else { + cfg.cn[0].cls += " nav-html"; + } + + if (this.menu) { + cfg.cn[0].html += " "; + + } + + if (this.badge !== '') { + cfg.cn[0].html += ' ' + this.badge + ''; + } + } + + + + 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.nav.Item.superclass.onRender.call(this, ct, position); + this.navLink = this.el.select('.nav-link',true).first(); + this.htmlEl = this.el.hasClass('nav-html') ? this.el : this.el.select('.nav-html',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.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 && p.pilltype) { + 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('.roo-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.nav.Group.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.nav.Group.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; //this.tagtype == 'a' ? this.el : 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; + }, + /** + * Set the HTML (text content) of the item + * @param {string} html content for the nav item + */ + setHtml : function(html) + { + this.html = html; + this.htmlEl.dom.innerHTML = html; + + } +}); + + + \ No newline at end of file diff --git a/Roo/bootstrap/nav/ProgressBar.js b/Roo/bootstrap/nav/ProgressBar.js new file mode 100644 index 0000000000..b5da843d1e --- /dev/null +++ b/Roo/bootstrap/nav/ProgressBar.js @@ -0,0 +1,252 @@ +/* + * - LGPL + * + * nav progress bar + * + */ + +/** + * @class Roo.bootstrap.nav.ProgressBar + * @extends Roo.bootstrap.Component + * @children Roo.bootstrap.nav.ProgressBarItem + * Bootstrap NavProgressBar class + * + * @constructor + * Create a new nav progress bar - a bar indicating step along a process + * @param {Object} config The config object + */ + +Roo.bootstrap.nav.ProgressBar = function(config){ + Roo.bootstrap.nav.ProgressBar.superclass.constructor.call(this, config); + + this.bullets = this.bullets || []; + +// Roo.bootstrap.nav.ProgressBar.register(this); + this.addEvents({ + /** + * @event changed + * Fires when the active item changes + * @param {Roo.bootstrap.nav.ProgressBar} this + * @param {Roo.bootstrap.nav.ProgressItem} selected The item selected + * @param {Roo.bootstrap.nav.ProgressItem} prev The previously selected item + */ + 'changed': true + }); + +}; + +Roo.extend(Roo.bootstrap.nav.ProgressBar, Roo.bootstrap.Component, { + /** + * @cfg {Roo.bootstrap.nav.ProgressItem} NavProgressBar:bullets[] + * Bullets for the Nav Progress bar for the toolbar + */ + bullets : [], + barItems : [], + + getAutoCreate : function() + { + var cfg = Roo.apply({}, Roo.bootstrap.nav.ProgressBar.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.nav.ProgressBar.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.nav.ProgressItem(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); + + } + +}); diff --git a/Roo/bootstrap/nav/ProgressBarItem.js b/Roo/bootstrap/nav/ProgressBarItem.js new file mode 100644 index 0000000000..6c5476dc60 --- /dev/null +++ b/Roo/bootstrap/nav/ProgressBarItem.js @@ -0,0 +1,152 @@ +/* + * - LGPL + * + * Nav Progress Item + * + */ + +/** + * @class Roo.bootstrap.nav.ProgressBarItem + * @extends Roo.bootstrap.Component + * Bootstrap NavProgressBarItem 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 NavProgressBarItem + * @param {Object} config The config object + */ +Roo.bootstrap.nav.ProgressBarItem = function(config){ + Roo.bootstrap.nav.ProgressBarItem.superclass.constructor.call(this, config); + this.addEvents({ + // raw events + /** + * @event click + * The raw click event for the entire grid. + * @param {Roo.bootstrap.nav.ProgressBarItem} this + * @param {Roo.EventObject} e + */ + "click" : true + }); + +}; + +Roo.extend(Roo.bootstrap.nav.ProgressBarItem, 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/Roo/bootstrap/nav/Sidebar.js b/Roo/bootstrap/nav/Sidebar.js new file mode 100644 index 0000000000..80e369f052 --- /dev/null +++ b/Roo/bootstrap/nav/Sidebar.js @@ -0,0 +1,47 @@ +/* + * - LGPL + * + * navbar + * + */ + +/** + * @class Roo.bootstrap.nav.Sidebar + * @extends Roo.bootstrap.Navbar + * @children Roo.bootstrap.nav.Group Roo.bootstrap.Container Roo.bootstrap.Form Roo.bootstrap.Row Roo.bootstrap.Column Roo.bootstrap.Link + * Bootstrap Sidebar class + * + * @constructor + * Create a new Sidebar + * @param {Object} config The config object + */ + + +Roo.bootstrap.nav.Sidebar = function(config){ + Roo.bootstrap.nav.Sidebar.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.nav.Sidebar, Roo.bootstrap.nav.Bar, { + + 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/Roo/bootstrap/nav/SidebarItem.js b/Roo/bootstrap/nav/SidebarItem.js new file mode 100644 index 0000000000..8728ceec61 --- /dev/null +++ b/Roo/bootstrap/nav/SidebarItem.js @@ -0,0 +1,228 @@ +/* + * - LGPL + * + * sidebar item + * + * li + * icon + * text + * badge + */ + +/** + * @class Roo.bootstrap.nav.SidebarItem + * @extends Roo.bootstrap.nav.Item + * 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.nav.SidebarItem = function(config){ + Roo.bootstrap.nav.SidebarItem.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.nav.SidebarItem} this + * @param {boolean} state the new state + + */ + 'changed': true + }); + +}; + +Roo.extend(Roo.bootstrap.nav.SidebarItem, Roo.bootstrap.nav.Item, { + + 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, e); + }, + + 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/Roo/bootstrap/nav/Simplebar.js b/Roo/bootstrap/nav/Simplebar.js new file mode 100644 index 0000000000..a1fbe6b532 --- /dev/null +++ b/Roo/bootstrap/nav/Simplebar.js @@ -0,0 +1,129 @@ +/* + * - LGPL + * + * navbar + * + */ + +/** + * @class Roo.bootstrap.nav.Simplebar + * @extends Roo.bootstrap.nav.Bar + * @children Roo.bootstrap.nav.Group Roo.bootstrap.Container Roo.bootstrap.Form Roo.bootstrap.Row Roo.bootstrap.Column Roo.bootstrap.Link + * 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.nav.Simplebar = function(config){ + Roo.bootstrap.nav.Simplebar.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.nav.Simplebar, Roo.bootstrap.nav.Bar, { + + inverse: false, + + type: false, + arrangement: '', + align : false, + + weight : 'light', + + main : false, + + + tag : false, + + + getAutoCreate : function(){ + + + var cfg = { + tag : this.tag || 'div', + cls : 'navbar roo-navbar-simple' //navbar-expand-lg ?? + }; + 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 && this.xtype == 'NavSimplebar') { + return cfg; + } + + + + + cfg.cn = [ + { + cls: 'nav nav-' + this.xtype, + 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/Roo/bootstrap/nav/depricated.js b/Roo/bootstrap/nav/depricated.js new file mode 100644 index 0000000000..15e548c661 --- /dev/null +++ b/Roo/bootstrap/nav/depricated.js @@ -0,0 +1,13 @@ +// depricated. +Roo.bootstrap.Navbar = Roo.bootstrap.nav.Bar; +Roo.bootstrap.NavGroup = Roo.bootstrap.nav.Group; +Roo.bootstrap.NavHeaderbar = Roo.bootstrap.nav.Headerbar; +Roo.bootstrap.NavItem = Roo.bootstrap.nav.Item; + +Roo.bootstrap.NavProgressBar = Roo.bootstrap.nav.ProgressBar; +Roo.bootstrap.NavProgressBarItem = Roo.bootstrap.nav.ProgressBarItem; + +Roo.bootstrap.NavSidebar = Roo.bootstrap.nav.Sidebar; +Roo.bootstrap.NavSidebarItem = Roo.bootstrap.nav.SidebarItem; + +Roo.bootstrap.NavSimplebar = Roo.bootstrap.nav.Simplebar; \ No newline at end of file diff --git a/docs/src/Roo_bootstrap_menu_depricated.js.html b/docs/src/Roo_bootstrap_menu_depricated.js.html new file mode 100644 index 0000000000..38fa1cb400 --- /dev/null +++ b/docs/src/Roo_bootstrap_menu_depricated.js.html @@ -0,0 +1,6 @@ +Roo/bootstrap/menu/depricated.js// deprciated +Roo.bootstrap.Menu = Roo.bootstrap.menu.Menu; +Roo.bootstrap.MenuItem = Roo.bootstrap.menu.Item; +Roo.bootstrap.MenuSeparator = Roo.bootstrap.menu.Separator + + \ No newline at end of file diff --git a/docs/src/Roo_bootstrap_nav_Bar.js.html b/docs/src/Roo_bootstrap_nav_Bar.js.html new file mode 100644 index 0000000000..7182601ffc --- /dev/null +++ b/docs/src/Roo_bootstrap_nav_Bar.js.html @@ -0,0 +1,172 @@ +Roo/bootstrap/nav/Bar.js/* + * - LGPL + * + * navbar + * + */ + +/** + * @class Roo.bootstrap.nav.Bar + * @extends Roo.bootstrap.Component + * @abstract + * Bootstrap Navbar class + + * @constructor + * Create a new Navbar + * @param {Object} config The config object + */ + + +Roo.bootstrap.nav.Bar = function(config){ + Roo.bootstrap.nav.Bar.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.nav.Bar, 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', this.onToggle , 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(); + }, + onToggle : function() + { + + if(this.fireEvent('beforetoggle', this) === false){ + return; + } + var ce = this.el.select('.navbar-collapse',true).first(); + + if (!ce.hasClass('show')) { + this.expand(); + } else { + this.collapse(); + } + + + + }, + /** + * Expand the navbar pulldown + */ + expand : function () + { + + var ce = this.el.select('.navbar-collapse',true).first(); + if (ce.hasClass('collapsing')) { + return; + } + ce.dom.style.height = ''; + // show it... + ce.addClass('in'); // old... + 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); + ce.dom.scrollTop = 0; + }, + /** + * Collapse the navbar pulldown + */ + collapse : function() + { + var ce = this.el.select('.navbar-collapse',true).first(); + + if (ce.hasClass('collapsing') || ce.hasClass('collapse') ) { + // it's collapsed or collapsing.. + return; + } + ce.removeClass('in'); // old... + 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); + } + + + +}); + + + + + + \ No newline at end of file diff --git a/docs/src/Roo_bootstrap_nav_Group.js.html b/docs/src/Roo_bootstrap_nav_Group.js.html new file mode 100644 index 0000000000..6a028ea897 --- /dev/null +++ b/docs/src/Roo_bootstrap_nav_Group.js.html @@ -0,0 +1,300 @@ +Roo/bootstrap/nav/Group.js/* + * - LGPL + * + * nav group + * + */ + +/** + * @class Roo.bootstrap.nav.Group + * @extends Roo.bootstrap.Component + * @children Roo.bootstrap.nav.Item + * 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. + * @cfg {Boolean} pilltype default true (turn to off to disable active toggle) + * + * @constructor + * Create a new nav group + * @param {Object} config The config object + */ + +Roo.bootstrap.nav.Group = function(config){ + Roo.bootstrap.nav.Group.superclass.constructor.call(this, config); + this.navItems = []; + + Roo.bootstrap.nav.Group.register(this); + this.addEvents({ + /** + * @event changed + * Fires when the active item changes + * @param {Roo.bootstrap.nav.Group} 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.nav.Group, Roo.bootstrap.Component, { + + align: '', + inverse: false, + form: false, + type: 'nav', + navId : '', + // private + pilltype : true, + + navItems : false, + + getAutoCreate : function() + { + var cfg = Roo.apply({}, Roo.bootstrap.nav.Group.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 { + // trying to remove so header bar can right align top? + if (this.parent() && this.parent().xtype != 'NavHeaderbar') { + // do not use on header bar... + 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' + }; + //nav navbar-right ml-md-auto + 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.nav.Item} 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.nav.Item} 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.nav.Item} the navitem to add + */ + addItem : function(cfg) + { + if (this.form && Roo.bootstrap.version == 4) { + cfg.tag = 'div'; + } + var cn = new Roo.bootstrap.nav.Item(cfg); + this.register(cn); + cn.parentId = this.id; + cn.onRender(this.el, null); + return cn; + }, + /** + * register a Navigation item + * @param {Roo.bootstrap.nav.Item} 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.nav.Group, { + + groups: {}, + /** + * register a Navigation Group + * @param {Roo.bootstrap.nav.Group} 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.nav.Group} the navgroup + */ + get: function(navId) { + if (typeof(this.groups[navId]) == 'undefined') { + return false; + //this.register(new Roo.bootstrap.nav.Group({ navId : navId })); + } + return this.groups[navId] ; + } + + + +}); + + \ No newline at end of file diff --git a/docs/src/Roo_bootstrap_nav_Headerbar.js.html b/docs/src/Roo_bootstrap_nav_Headerbar.js.html new file mode 100644 index 0000000000..985eafb7a2 --- /dev/null +++ b/docs/src/Roo_bootstrap_nav_Headerbar.js.html @@ -0,0 +1,188 @@ +Roo/bootstrap/nav/Headerbar.js/* + * - LGPL + * + * navbar + * navbar-fixed-top + * navbar-expand-md fixed-top + */ + +/** + * @class Roo.bootstrap.nav.Headerbar + * @extends Roo.bootstrap.nav.Simplebar + * @children Roo.bootstrap.nav.Group Roo.bootstrap.Container Roo.bootstrap.Form Roo.bootstrap.Row Roo.bootstrap.Column Roo.bootstrap.Link + * 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.nav.Headerbar = function(config){ + Roo.bootstrap.nav.Headerbar.superclass.constructor.call(this, config); + +}; + +Roo.extend(Roo.bootstrap.nav.Headerbar, Roo.bootstrap.nav.Simplebar, { + + 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: Roo.bootstrap.version == 4 ? 'nav flex-row roo-navbar-collapse collapse navbar-collapse' : 'collapse navbar-collapse roo-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(); + }, + + getChildContainer : function() + { + + return this.el.select('.roo-navbar-collapse',true).first(); + + + }, + + initEvents : function() + { + Roo.bootstrap.nav.Headerbar.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/docs/src/Roo_bootstrap_nav_Item.js.html b/docs/src/Roo_bootstrap_nav_Item.js.html new file mode 100644 index 0000000000..9d3ac8f70c --- /dev/null +++ b/docs/src/Roo_bootstrap_nav_Item.js.html @@ -0,0 +1,379 @@ +Roo/bootstrap/nav/Item.js/** + * @class Roo.bootstrap.nav.Item + * @extends Roo.bootstrap.Component + * @children Roo.bootstrap.Container Roo.bootstrap.Button + * @licence LGPL + * Bootstrap Navbar.NavItem class + * + * @cfg {String} href link to + * @cfg {String} button_weight (default|primary|secondary|success|info|warning|danger|link|light|dark) default none + * @cfg {Boolean} button_outline show and outlined button + * @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 {String} linkcls Link Class + * @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 + * @cfg {Roo.bootstrap.menu.Menu} menu a Menu + + * @constructor + * Create a new Navbar Item + * @param {Object} config The config object + */ +Roo.bootstrap.nav.Item = function(config){ + Roo.bootstrap.nav.Item.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.nav.Item} this + * @param {boolean} state the new state + + */ + 'changed': true, + /** + * @event scrollto + * Fires when scroll to element + * @param {Roo.bootstrap.nav.Item} this + * @param {Object} options + * @param {Roo.EventObject} e + + */ + 'scrollto': true + }); + +}; + +Roo.extend(Roo.bootstrap.nav.Item, 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, + linkcls : '', + navLink: false, + + getAutoCreate : function(){ + + var cfg = { + tag: this.tag, + cls: 'nav-item' + }; + + cfg.cls = typeof(cfg.cls) == 'undefined' ? '' : cfg.cls; + + if (this.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 class="nav-html">' + this.html + '</span>'; + } else { + cfg.cls += " nav-html"; + } + + // 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 || '', + cls : '' + } + ]; + if (this.tagtype == 'a') { + cfg.cn[0].cls = 'nav-link' + (this.active ? ' active' : '') + ' ' + this.linkcls; + + } + if (this.icon) { + cfg.cn[0].html = '<i class="'+this.icon+'"></i> <span class="nav-html">' + cfg.cn[0].html + '</span>'; + } else if (this.fa) { + cfg.cn[0].html = '<i class="fa fas fa-'+this.fa+'"></i> <span class="nav-html">' + cfg.cn[0].html + '</span>'; + } else if(this.glyphicon) { + cfg.cn[0].html = '<span class="glyphicon glyphicon-' + this.glyphicon + '"></span> ' + cfg.cn[0].html; + } else { + cfg.cn[0].cls += " nav-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.nav.Item.superclass.onRender.call(this, ct, position); + this.navLink = this.el.select('.nav-link',true).first(); + this.htmlEl = this.el.hasClass('nav-html') ? this.el : this.el.select('.nav-html',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.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 && p.pilltype) { + 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('.roo-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.nav.Group.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.nav.Group.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; //this.tagtype == 'a' ? this.el : 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; + }, + /** + * Set the HTML (text content) of the item + * @param {string} html content for the nav item + */ + setHtml : function(html) + { + this.html = html; + this.htmlEl.dom.innerHTML = html; + + } +}); + + + \ No newline at end of file diff --git a/docs/src/Roo_bootstrap_nav_ProgressBar.js.html b/docs/src/Roo_bootstrap_nav_ProgressBar.js.html new file mode 100644 index 0000000000..925cdf4f60 --- /dev/null +++ b/docs/src/Roo_bootstrap_nav_ProgressBar.js.html @@ -0,0 +1,253 @@ +Roo/bootstrap/nav/ProgressBar.js/* + * - LGPL + * + * nav progress bar + * + */ + +/** + * @class Roo.bootstrap.nav.ProgressBar + * @extends Roo.bootstrap.Component + * @children Roo.bootstrap.nav.ProgressBarItem + * Bootstrap NavProgressBar class + * + * @constructor + * Create a new nav progress bar - a bar indicating step along a process + * @param {Object} config The config object + */ + +Roo.bootstrap.nav.ProgressBar = function(config){ + Roo.bootstrap.nav.ProgressBar.superclass.constructor.call(this, config); + + this.bullets = this.bullets || []; + +// Roo.bootstrap.nav.ProgressBar.register(this); + this.addEvents({ + /** + * @event changed + * Fires when the active item changes + * @param {Roo.bootstrap.nav.ProgressBar} this + * @param {Roo.bootstrap.nav.ProgressItem} selected The item selected + * @param {Roo.bootstrap.nav.ProgressItem} prev The previously selected item + */ + 'changed': true + }); + +}; + +Roo.extend(Roo.bootstrap.nav.ProgressBar, Roo.bootstrap.Component, { + /** + * @cfg {Roo.bootstrap.nav.ProgressItem} NavProgressBar:bullets[] + * Bullets for the Nav Progress bar for the toolbar + */ + bullets : [], + barItems : [], + + getAutoCreate : function() + { + var cfg = Roo.apply({}, Roo.bootstrap.nav.ProgressBar.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.nav.ProgressBar.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.nav.ProgressItem(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/docs/src/Roo_bootstrap_nav_ProgressBarItem.js.html b/docs/src/Roo_bootstrap_nav_ProgressBarItem.js.html new file mode 100644 index 0000000000..4b865dc16b --- /dev/null +++ b/docs/src/Roo_bootstrap_nav_ProgressBarItem.js.html @@ -0,0 +1,152 @@ +Roo/bootstrap/nav/ProgressBarItem.js/* + * - LGPL + * + * Nav Progress Item + * + */ + +/** + * @class Roo.bootstrap.nav.ProgressBarItem + * @extends Roo.bootstrap.Component + * Bootstrap NavProgressBarItem 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 NavProgressBarItem + * @param {Object} config The config object + */ +Roo.bootstrap.nav.ProgressBarItem = function(config){ + Roo.bootstrap.nav.ProgressBarItem.superclass.constructor.call(this, config); + this.addEvents({ + // raw events + /** + * @event click + * The raw click event for the entire grid. + * @param {Roo.bootstrap.nav.ProgressBarItem} this + * @param {Roo.EventObject} e + */ + "click" : true + }); + +}; + +Roo.extend(Roo.bootstrap.nav.ProgressBarItem, 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/docs/src/Roo_bootstrap_nav_Sidebar.js.html b/docs/src/Roo_bootstrap_nav_Sidebar.js.html new file mode 100644 index 0000000000..3bc33b4058 --- /dev/null +++ b/docs/src/Roo_bootstrap_nav_Sidebar.js.html @@ -0,0 +1,47 @@ +Roo/bootstrap/nav/Sidebar.js/* + * - LGPL + * + * navbar + * + */ + +/** + * @class Roo.bootstrap.nav.Sidebar + * @extends Roo.bootstrap.Navbar + * @children Roo.bootstrap.nav.Group Roo.bootstrap.Container Roo.bootstrap.Form Roo.bootstrap.Row Roo.bootstrap.Column Roo.bootstrap.Link + * Bootstrap Sidebar class + * + * @constructor + * Create a new Sidebar + * @param {Object} config The config object + */ + + +Roo.bootstrap.nav.Sidebar = function(config){ + Roo.bootstrap.nav.Sidebar.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.nav.Sidebar, Roo.bootstrap.nav.Bar, { + + 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/docs/src/Roo_bootstrap_nav_SidebarItem.js.html b/docs/src/Roo_bootstrap_nav_SidebarItem.js.html new file mode 100644 index 0000000000..0d1ca41bd5 --- /dev/null +++ b/docs/src/Roo_bootstrap_nav_SidebarItem.js.html @@ -0,0 +1,228 @@ +Roo/bootstrap/nav/SidebarItem.js/* + * - LGPL + * + * sidebar item + * + * li + * <span> icon </span> + * <span> text </span> + * <span>badge </span> + */ + +/** + * @class Roo.bootstrap.nav.SidebarItem + * @extends Roo.bootstrap.nav.Item + * 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.nav.SidebarItem = function(config){ + Roo.bootstrap.nav.SidebarItem.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.nav.SidebarItem} this + * @param {boolean} state the new state + + */ + 'changed': true + }); + +}; + +Roo.extend(Roo.bootstrap.nav.SidebarItem, Roo.bootstrap.nav.Item, { + + 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, e); + }, + + 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/docs/src/Roo_bootstrap_nav_Simplebar.js.html b/docs/src/Roo_bootstrap_nav_Simplebar.js.html new file mode 100644 index 0000000000..b0bf950e9a --- /dev/null +++ b/docs/src/Roo_bootstrap_nav_Simplebar.js.html @@ -0,0 +1,129 @@ +Roo/bootstrap/nav/Simplebar.js/* + * - LGPL + * + * navbar + * + */ + +/** + * @class Roo.bootstrap.nav.Simplebar + * @extends Roo.bootstrap.nav.Bar + * @children Roo.bootstrap.nav.Group Roo.bootstrap.Container Roo.bootstrap.Form Roo.bootstrap.Row Roo.bootstrap.Column Roo.bootstrap.Link + * 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.nav.Simplebar = function(config){ + Roo.bootstrap.nav.Simplebar.superclass.constructor.call(this, config); +}; + +Roo.extend(Roo.bootstrap.nav.Simplebar, Roo.bootstrap.nav.Bar, { + + inverse: false, + + type: false, + arrangement: '', + align : false, + + weight : 'light', + + main : false, + + + tag : false, + + + getAutoCreate : function(){ + + + var cfg = { + tag : this.tag || 'div', + cls : 'navbar roo-navbar-simple' //navbar-expand-lg ?? + }; + 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 && this.xtype == 'NavSimplebar') { + return cfg; + } + + + + + cfg.cn = [ + { + cls: 'nav nav-' + this.xtype, + 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/docs/src/Roo_bootstrap_nav_depricated.js.html b/docs/src/Roo_bootstrap_nav_depricated.js.html new file mode 100644 index 0000000000..720f704e39 --- /dev/null +++ b/docs/src/Roo_bootstrap_nav_depricated.js.html @@ -0,0 +1,13 @@ +Roo/bootstrap/nav/depricated.js// depricated. +Roo.bootstrap.Navbar = Roo.bootstrap.nav.Bar; +Roo.bootstrap.NavGroup = Roo.bootstrap.nav.Group; +Roo.bootstrap.NavHeaderbar = Roo.bootstrap.nav.Headerbar; +Roo.bootstrap.NavItem = Roo.bootstrap.nav.Item; + +Roo.bootstrap.NavProgressBar = Roo.bootstrap.nav.ProgressBar; +Roo.bootstrap.NavProgressBarItem = Roo.bootstrap.nav.ProgressBarItem; + +Roo.bootstrap.NavSidebar = Roo.bootstrap.nav.Sidebar; +Roo.bootstrap.NavSidebarItem = Roo.bootstrap.nav.SidebarItem; + +Roo.bootstrap.NavSimplebar = Roo.bootstrap.nav.Simplebar; \ No newline at end of file diff --git a/docs/src/Roo_bootstrap_nav_namespace.js.html b/docs/src/Roo_bootstrap_nav_namespace.js.html new file mode 100644 index 0000000000..6d95ba111f --- /dev/null +++ b/docs/src/Roo_bootstrap_nav_namespace.js.html @@ -0,0 +1,3 @@ +Roo/bootstrap/nav/namespace.jsRoo.bootstrap.nav = {}; + + \ No newline at end of file diff --git a/docs/symbols/Roo.bootstrap.nav.Bar.json b/docs/symbols/Roo.bootstrap.nav.Bar.json new file mode 100644 index 0000000000..910d6e2910 --- /dev/null +++ b/docs/symbols/Roo.bootstrap.nav.Bar.json @@ -0,0 +1,1145 @@ +{ + "name" : "Roo.bootstrap.nav.Bar", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "childClasses" : [ + "Roo.bootstrap.PagingToolbar", + "Roo.bootstrap.htmleditor.ToolbarStandard", + "Roo.bootstrap.PopoverNav", + "Roo.bootstrap.nav.Simplebar", + "Roo.bootstrap.nav.Headerbar" + ], + "desc" : "Bootstrap Navbar class", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "memberOf" : "Bar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "The config object", + "isOptional" : false + } + ], + "returns" : [], + "throws" : "", + "requires" : "", + "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" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "t) What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "y)\nHow 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" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "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" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl", + "memberOf" : "Roo.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "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" + } + ], + "methods" : [ + { + "name" : "collapse", + "type" : "function", + "desc" : "Collapse the navbar pulldown", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "expand", + "type" : "function", + "desc" : "Expand the navbar pulldown", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(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", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "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", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "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", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "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", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(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" : "beforetoggle", + "type" : "function", + "desc" : "Fire before toggle the menu", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + } + ] +} \ No newline at end of file diff --git a/docs/symbols/Roo.bootstrap.nav.Group.json b/docs/symbols/Roo.bootstrap.nav.Group.json new file mode 100644 index 0000000000..16984537e2 --- /dev/null +++ b/docs/symbols/Roo.bootstrap.nav.Group.json @@ -0,0 +1,1317 @@ +{ + "name" : "Roo.bootstrap.nav.Group", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "childClasses" : [], + "desc" : "Bootstrap NavGroup class", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "memberOf" : "Group", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "The config object", + "isOptional" : false + } + ], + "returns" : [], + "throws" : "", + "requires" : "", + "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" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "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" : "visibilityEl", + "type" : "string|object", + "desc" : "t) What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "align", + "type" : "String", + "desc" : "t)", + "memberOf" : "" + }, + { + "name" : "inverse", + "type" : "Boolean", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "pilltype", + "type" : "Boolean", + "desc" : "default true (turn to off to disable active toggle)", + "memberOf" : "" + }, + { + "name" : "navId", + "type" : "String", + "desc" : "- reference Id for navbar.", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "y)\nHow 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" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "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" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl", + "memberOf" : "Roo.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "type", + "type" : "String", + "desc" : "b) default nav", + "memberOf" : "" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "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" + } + ], + "methods" : [ + { + "name" : "get", + "type" : "function", + "desc" : "fetch a Navigation Group based on the navigation ID", + "sig" : "(the)", + "static" : true, + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "string", + "desc" : "navgroup to add", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "addItem", + "type" : "function", + "desc" : "adds a Navigation item", + "sig" : "(the)", + "static" : false, + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.nav.Item", + "desc" : "navitem to add", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "register", + "type" : "function", + "desc" : "register a Navigation item", + "sig" : "(the)", + "static" : false, + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.nav.Item", + "desc" : "navitem to add", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "getActive", + "type" : "function", + "desc" : "gets the active Navigation item", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.bootstrap.nav.Item", + "desc" : "the current navitem" + } + ] + }, + { + "name" : "setActiveItem", + "type" : "function", + "desc" : "sets the active Navigation item", + "sig" : "(the)", + "static" : false, + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.nav.Item", + "desc" : "new current navitem", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "clearAll", + "type" : "function", + "desc" : "clear all the Navigation item", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "register", + "type" : "function", + "desc" : "register a Navigation Group", + "sig" : "(the)", + "static" : true, + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.nav.Group", + "desc" : "navgroup to add", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(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", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "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", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "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", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "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", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(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" : "changed", + "type" : "function", + "desc" : "Fires when the active item changes", + "sig" : "function (_self, selected, prev)\n{\n\n}", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.nav.Group", + "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", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + } + ] +} \ No newline at end of file diff --git a/docs/symbols/Roo.bootstrap.nav.Headerbar.json b/docs/symbols/Roo.bootstrap.nav.Headerbar.json new file mode 100644 index 0000000000..9f431bdf20 --- /dev/null +++ b/docs/symbols/Roo.bootstrap.nav.Headerbar.json @@ -0,0 +1,1231 @@ +{ + "name" : "Roo.bootstrap.nav.Headerbar", + "augments" : [ + "Roo.bootstrap.nav.Simplebar", + "Roo.bootstrap.nav.Bar", + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "childClasses" : [], + "desc" : "Bootstrap Sidebar class", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "memberOf" : "Headerbar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "The config object", + "isOptional" : false + } + ], + "returns" : [], + "throws" : "", + "requires" : "", + "config" : [ + { + "name" : "brand_href", + "type" : "String", + "desc" : "href of the brand", + "memberOf" : "" + }, + { + "name" : "desktopCenter", + "type" : "Boolean", + "desc" : "should the header be centered on desktop using a container class", + "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" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "t) What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "inverse", + "type" : "Boolean", + "desc" : "is inverted color", + "memberOf" : "Roo.bootstrap.nav.Simplebar" + }, + { + "name" : "align", + "type" : "String", + "desc" : "t) alignment", + "memberOf" : "Roo.bootstrap.nav.Simplebar" + }, + { + "name" : "brand", + "type" : "String", + "desc" : "what is brand", + "memberOf" : "" + }, + { + "name" : "position", + "type" : "String", + "desc" : "p) position", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "y)\nHow 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" + }, + { + "name" : "srButton", + "type" : "Boolean", + "desc" : "generate the (screen reader / mobile) sr-only button default true", + "memberOf" : "" + }, + { + "name" : "tag", + "type" : "String", + "desc" : "v) default is nav", + "memberOf" : "Roo.bootstrap.nav.Simplebar" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "mobilerow", + "type" : "Roo.bootstrap.Row", + "desc" : "- a row to display on mobile only..", + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "arrangement", + "type" : "Boolean", + "desc" : "stacked | justified", + "memberOf" : "Roo.bootstrap.nav.Simplebar" + }, + { + "name" : "loadMask", + "type" : "Boolean", + "desc" : "e) loadMask on the bar", + "memberOf" : "Roo.bootstrap.nav.Simplebar" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl", + "memberOf" : "Roo.Component" + }, + { + "name" : "main", + "type" : "Boolean", + "desc" : "e) main nav bar? default false", + "memberOf" : "Roo.bootstrap.nav.Simplebar" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "type", + "type" : "String", + "desc" : "s)", + "memberOf" : "Roo.bootstrap.nav.Simplebar" + }, + { + "name" : "weight", + "type" : "String", + "desc" : "e) default is light.", + "memberOf" : "Roo.bootstrap.nav.Simplebar" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "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" : "autohide", + "type" : "Boolean", + "desc" : "a top nav bar header that hides on scroll.", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "collapse", + "type" : "function", + "desc" : "Collapse the navbar pulldown", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.nav.Bar", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "expand", + "type" : "function", + "desc" : "Expand the navbar pulldown", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.nav.Bar", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(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", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "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", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "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", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "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", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(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" : "beforetoggle", + "type" : "function", + "desc" : "Fire before toggle the menu", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.nav.Bar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + } + ] +} \ No newline at end of file diff --git a/docs/symbols/Roo.bootstrap.nav.Item.json b/docs/symbols/Roo.bootstrap.nav.Item.json new file mode 100644 index 0000000000..06f28338c9 --- /dev/null +++ b/docs/symbols/Roo.bootstrap.nav.Item.json @@ -0,0 +1,1289 @@ +{ + "name" : "Roo.bootstrap.nav.Item", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "childClasses" : [ + "Roo.bootstrap.nav.SidebarItem" + ], + "desc" : "Bootstrap Navbar.NavItem class", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "memberOf" : "Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "The config object", + "isOptional" : false + } + ], + "returns" : [], + "throws" : "", + "requires" : "", + "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" + }, + { + "name" : "linkcls", + "type" : "String", + "desc" : "Link Class", + "memberOf" : "" + }, + { + "name" : "tagtype", + "type" : "String", + "desc" : "n) render as a href or span?", + "memberOf" : "" + }, + { + "name" : "animateRef", + "type" : "Boolean", + "desc" : "e) link to element default false", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "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" : "visibilityEl", + "type" : "string|object", + "desc" : "t) What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tabId", + "type" : "String", + "desc" : "the tab that this item activates.", + "memberOf" : "" + }, + { + "name" : "menu", + "type" : "Roo.bootstrap.menu.Menu", + "desc" : "a Menu", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "y)\nHow 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" + }, + { + "name" : "badge", + "type" : "String", + "desc" : "text inside badge", + "memberOf" : "" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "Is item disabled", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "button_outline", + "type" : "Boolean", + "desc" : "show and outlined button", + "memberOf" : "" + }, + { + "name" : "html", + "type" : "String", + "desc" : "content of button", + "memberOf" : "" + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : "e) default false", + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "glyphicon", + "type" : "String", + "desc" : "DEPRICATED - use fa", + "memberOf" : "" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl", + "memberOf" : "Roo.Component" + }, + { + "name" : "icon", + "type" : "String", + "desc" : "DEPRICATED - use fa", + "memberOf" : "" + }, + { + "name" : "badgecls", + "type" : "String", + "desc" : "w)the extra classes for the badge", + "memberOf" : "" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "button_weight", + "type" : "String", + "desc" : "k) default none", + "memberOf" : "" + }, + { + "name" : "fa", + "type" : "String", + "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)", + "memberOf" : "" + }, + { + "name" : "active", + "type" : "Boolean", + "desc" : "Is item active", + "memberOf" : "" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "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" : "href", + "type" : "String", + "desc" : "link to", + "memberOf" : "" + } + ], + "methods" : [ + { + "name" : "setHtml", + "type" : "function", + "desc" : "Set the HTML (text content) of the item", + "sig" : "(html)", + "static" : false, + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "html", + "type" : "string", + "desc" : "content for the nav item", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(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", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "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", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "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", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "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", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(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" : "click", + "type" : "function", + "desc" : "The raw click event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "scrollto", + "type" : "function", + "desc" : "Fires when scroll to element", + "sig" : "function (_self, options, e)\n{\n\n}", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.nav.Item", + "desc" : "", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "changed", + "type" : "function", + "desc" : "Fires when the active item active state changes", + "sig" : "function (_self, state)\n{\n\n}", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.nav.Item", + "desc" : "", + "isOptional" : false + }, + { + "name" : "state", + "type" : "boolean", + "desc" : "the new state", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + } + ] +} \ No newline at end of file diff --git a/docs/symbols/Roo.bootstrap.nav.ProgressBar.json b/docs/symbols/Roo.bootstrap.nav.ProgressBar.json new file mode 100644 index 0000000000..22f46ff3b6 --- /dev/null +++ b/docs/symbols/Roo.bootstrap.nav.ProgressBar.json @@ -0,0 +1,1119 @@ +{ + "name" : "Roo.bootstrap.nav.ProgressBar", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "childClasses" : [], + "desc" : "Bootstrap NavProgressBar class", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "memberOf" : "ProgressBar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "The config object", + "isOptional" : false + } + ], + "returns" : [], + "throws" : "", + "requires" : "", + "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" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "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" : "visibilityEl", + "type" : "string|object", + "desc" : "t) What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "y)\nHow 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" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "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" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl", + "memberOf" : "Roo.Component" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "NavProgressBar:bullets[]", + "type" : "Roo.bootstrap.nav.ProgressItem", + "desc" : "Bullets for the Nav Progress bar for the toolbar", + "memberOf" : "" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "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" + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(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", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "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", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "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", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "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", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(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" : "changed", + "type" : "function", + "desc" : "Fires when the active item changes", + "sig" : "function (_self, selected, prev)\n{\n\n}", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.nav.ProgressBar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "selected", + "type" : "Roo.bootstrap.nav.ProgressItem", + "desc" : "The item selected", + "isOptional" : false + }, + { + "name" : "prev", + "type" : "Roo.bootstrap.nav.ProgressItem", + "desc" : "The previously selected item", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + } + ] +} \ No newline at end of file diff --git a/docs/symbols/Roo.bootstrap.nav.ProgressBarItem.json b/docs/symbols/Roo.bootstrap.nav.ProgressBarItem.json new file mode 100644 index 0000000000..27d3ba1874 --- /dev/null +++ b/docs/symbols/Roo.bootstrap.nav.ProgressBarItem.json @@ -0,0 +1,1143 @@ +{ + "name" : "Roo.bootstrap.nav.ProgressBarItem", + "augments" : [ + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "childClasses" : [], + "desc" : "Bootstrap NavProgressBarItem class", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "memberOf" : "ProgressBarItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "The config object", + "isOptional" : false + } + ], + "returns" : [], + "throws" : "", + "requires" : "", + "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" + }, + { + "name" : "rid", + "type" : "String", + "desc" : "the reference id", + "memberOf" : "" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "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" : "visibilityEl", + "type" : "string|object", + "desc" : "t) What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "position", + "type" : "String", + "desc" : "m) text position default bottom", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "y)\nHow 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" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "e) Is item active default false", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "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" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl", + "memberOf" : "Roo.Component" + }, + { + "name" : "icon", + "type" : "String", + "desc" : "show icon instead of number", + "memberOf" : "" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "active", + "type" : "Boolean", + "desc" : "e) Is item active default false", + "memberOf" : "" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "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" + } + ], + "methods" : [ + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(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", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "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", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "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", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "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", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(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" : "click", + "type" : "function", + "desc" : "The raw click event for the entire grid.", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.nav.ProgressBarItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + } + ] +} \ No newline at end of file diff --git a/docs/symbols/Roo.bootstrap.nav.Sidebar.json b/docs/symbols/Roo.bootstrap.nav.Sidebar.json new file mode 100644 index 0000000000..a9ebf5019a --- /dev/null +++ b/docs/symbols/Roo.bootstrap.nav.Sidebar.json @@ -0,0 +1,28 @@ +{ + "name" : "Roo.bootstrap.nav.Sidebar", + "augments" : [], + "childClasses" : [], + "desc" : "Bootstrap Sidebar class", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "memberOf" : "Sidebar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "The config object", + "isOptional" : false + } + ], + "returns" : [], + "throws" : "", + "requires" : "", + "config" : [], + "methods" : [], + "events" : [] +} \ No newline at end of file diff --git a/docs/symbols/Roo.bootstrap.nav.SidebarItem.json b/docs/symbols/Roo.bootstrap.nav.SidebarItem.json new file mode 100644 index 0000000000..f6dfe2c2a2 --- /dev/null +++ b/docs/symbols/Roo.bootstrap.nav.SidebarItem.json @@ -0,0 +1,1288 @@ +{ + "name" : "Roo.bootstrap.nav.SidebarItem", + "augments" : [ + "Roo.bootstrap.nav.Item", + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "childClasses" : [], + "desc" : "Bootstrap Navbar.NavSidebarItem class\n\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" : false, + "isBuiltin" : false, + "memberOf" : "SidebarItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "The config object", + "isOptional" : false + } + ], + "returns" : [], + "throws" : "", + "requires" : "", + "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" + }, + { + "name" : "animateRef", + "type" : "Boolean", + "desc" : "e) link to element default false", + "memberOf" : "Roo.bootstrap.nav.Item" + }, + { + "name" : "linkcls", + "type" : "String", + "desc" : "Link Class", + "memberOf" : "Roo.bootstrap.nav.Item" + }, + { + "name" : "tagtype", + "type" : "String", + "desc" : "n) render as a href or span?", + "memberOf" : "Roo.bootstrap.nav.Item" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "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" : "visibilityEl", + "type" : "string|object", + "desc" : "t) What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tabId", + "type" : "String", + "desc" : "the tab that this item activates.", + "memberOf" : "Roo.bootstrap.nav.Item" + }, + { + "name" : "menu", + "type" : "Roo.bootstrap.menu.Menu", + "desc" : "a Menu", + "memberOf" : "Roo.bootstrap.nav.Item" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "y)\nHow 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" + }, + { + "name" : "badge", + "type" : "String", + "desc" : "text inside badge", + "memberOf" : "Roo.bootstrap.nav.Item" + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "Is item disabled", + "memberOf" : "Roo.bootstrap.nav.Item" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "button_outline", + "type" : "Boolean", + "desc" : "show and outlined button", + "memberOf" : "Roo.bootstrap.nav.Item" + }, + { + "name" : "html", + "type" : "String", + "desc" : "content of button", + "memberOf" : "Roo.bootstrap.nav.Item" + }, + { + "name" : "preventDefault", + "type" : "Boolean", + "desc" : "e) default false", + "memberOf" : "Roo.bootstrap.nav.Item" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "glyphicon", + "type" : "String", + "desc" : "DEPRICATED - use fa", + "memberOf" : "Roo.bootstrap.nav.Item" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl", + "memberOf" : "Roo.Component" + }, + { + "name" : "icon", + "type" : "String", + "desc" : "DEPRICATED - use fa", + "memberOf" : "Roo.bootstrap.nav.Item" + }, + { + "name" : "badgecls", + "type" : "String", + "desc" : "w)the extra classes for the badge", + "memberOf" : "Roo.bootstrap.nav.Item" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "button_weight", + "type" : "String", + "desc" : "k) default none", + "memberOf" : "Roo.bootstrap.nav.Item" + }, + { + "name" : "fa", + "type" : "String", + "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)", + "memberOf" : "Roo.bootstrap.nav.Item" + }, + { + "name" : "active", + "type" : "Boolean", + "desc" : "Is item active", + "memberOf" : "Roo.bootstrap.nav.Item" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "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" : "href", + "type" : "String", + "desc" : "link to", + "memberOf" : "Roo.bootstrap.nav.Item" + } + ], + "methods" : [ + { + "name" : "setHtml", + "type" : "function", + "desc" : "Set the HTML (text content) of the item", + "sig" : "(html)", + "static" : false, + "memberOf" : "Roo.bootstrap.nav.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "html", + "type" : "string", + "desc" : "content for the nav item", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.nav.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(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", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "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", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "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", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "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", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(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" : "click", + "type" : "function", + "desc" : "The raw click event for the entire grid.", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "changed", + "type" : "function", + "desc" : "Fires when the active item active state changes", + "sig" : "function (_self, state)\n{\n\n}", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.nav.SidebarItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "state", + "type" : "boolean", + "desc" : "the new state", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "scrollto", + "type" : "function", + "desc" : "Fires when scroll to element", + "sig" : "function (_self, options, e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.nav.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.nav.Item", + "desc" : "", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + } + ] +} \ No newline at end of file diff --git a/docs/symbols/Roo.bootstrap.nav.Simplebar.json b/docs/symbols/Roo.bootstrap.nav.Simplebar.json new file mode 100644 index 0000000000..93ff424c5f --- /dev/null +++ b/docs/symbols/Roo.bootstrap.nav.Simplebar.json @@ -0,0 +1,1193 @@ +{ + "name" : "Roo.bootstrap.nav.Simplebar", + "augments" : [ + "Roo.bootstrap.nav.Bar", + "Roo.bootstrap.Component", + "Roo.Component", + "Roo.util.Observable" + ], + "childClasses" : [ + "Roo.bootstrap.PagingToolbar", + "Roo.bootstrap.htmleditor.ToolbarStandard", + "Roo.bootstrap.PopoverNav", + "Roo.bootstrap.nav.Headerbar" + ], + "desc" : "Bootstrap Sidebar class", + "isSingleton" : false, + "isStatic" : false, + "isBuiltin" : false, + "memberOf" : "Simplebar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "The config object", + "isOptional" : false + } + ], + "returns" : [], + "throws" : "", + "requires" : "", + "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" + }, + { + "name" : "container_method", + "type" : "string", + "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "tooltip", + "type" : "string", + "desc" : "Text for the tooltip", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "visibilityEl", + "type" : "string|object", + "desc" : "t) What element to use for visibility (@see getVisibilityEl())", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "inverse", + "type" : "Boolean", + "desc" : "is inverted color", + "memberOf" : "" + }, + { + "name" : "align", + "type" : "String", + "desc" : "t) alignment", + "memberOf" : "" + }, + { + "name" : "can_build_overlaid", + "type" : "Boolean", + "desc" : "True if element can be rebuild from a HTML page", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "hideMode", + "type" : "String", + "desc" : "y)\nHow 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" + }, + { + "name" : "tag", + "type" : "String", + "desc" : "v) default is nav", + "memberOf" : "" + }, + { + "name" : "style", + "type" : "String", + "desc" : "any extra css", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "allowDomMove", + "type" : "Boolean", + "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", + "memberOf" : "Roo.Component" + }, + { + "name" : "cls", + "type" : "String", + "desc" : "css class", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "arrangement", + "type" : "Boolean", + "desc" : "stacked | justified", + "memberOf" : "" + }, + { + "name" : "loadMask", + "type" : "Boolean", + "desc" : "e) loadMask on the bar", + "memberOf" : "" + }, + { + "name" : "xattr", + "type" : "Object", + "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "actionMode", + "type" : "String", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl", + "memberOf" : "Roo.Component" + }, + { + "name" : "main", + "type" : "Boolean", + "desc" : "e) main nav bar? default false", + "memberOf" : "" + }, + { + "name" : "dataId", + "type" : "string", + "desc" : "cutomer id", + "memberOf" : "Roo.bootstrap.Component" + }, + { + "name" : "type", + "type" : "String", + "desc" : "s)", + "memberOf" : "" + }, + { + "name" : "weight", + "type" : "String", + "desc" : "e) default is light.", + "memberOf" : "" + }, + { + "name" : "name", + "type" : "string", + "desc" : "Specifies name attribute", + "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" + } + ], + "methods" : [ + { + "name" : "collapse", + "type" : "function", + "desc" : "Collapse the navbar pulldown", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.nav.Bar", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "expand", + "type" : "function", + "desc" : "Expand the navbar pulldown", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.nav.Bar", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "tooltipEl", + "type" : "function", + "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "show", + "type" : "function", + "desc" : "Show a component - removes 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "initEvents", + "type" : "function", + "desc" : "Initialize Events for the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "getChildContainer", + "type" : "function", + "desc" : "Fetch the element to add children to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] + }, + { + "name" : "getId", + "type" : "function", + "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "isVisible", + "type" : "function", + "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "name" : "setDisabled", + "type" : "function", + "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "focus", + "type" : "function", + "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "setVisible", + "type" : "function", + "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "visible", + "type" : "Boolean", + "desc" : "True to show, false to hide", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] + }, + { + "name" : "getEl", + "type" : "function", + "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] + }, + { + "name" : "purgeListeners", + "type" : "function", + "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] + }, + { + "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", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(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", + "type" : "function", + "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "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", + "type" : "function", + "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "releaseCapture", + "type" : "function", + "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "removeListener", + "type" : "function", + "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "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", + "type" : "function", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "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", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "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", + "type" : "function", + "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(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" : "beforetoggle", + "type" : "function", + "desc" : "Fire before toggle the menu", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "Roo.bootstrap.nav.Bar", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "childrenrendered", + "type" : "function", + "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "disable", + "type" : "function", + "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "render", + "type" : "function", + "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "destroy", + "type" : "function", + "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "hide", + "type" : "function", + "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "show", + "type" : "function", + "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "name" : "enable", + "type" : "function", + "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] + } + ] +} \ No newline at end of file diff --git a/docs/symbols/Roo.bootstrap.nav.json b/docs/symbols/Roo.bootstrap.nav.json new file mode 100644 index 0000000000..03464a63c4 --- /dev/null +++ b/docs/symbols/Roo.bootstrap.nav.json @@ -0,0 +1,21 @@ +{ + "name" : "Roo.bootstrap.nav", + "augments" : [], + "childClasses" : [], + "desc" : "", + "isSingleton" : false, + "isStatic" : true, + "isBuiltin" : false, + "memberOf" : "Roo.bootstrap.nav", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [], + "returns" : [], + "throws" : "", + "requires" : "", + "config" : [], + "methods" : [], + "events" : [] +} \ No newline at end of file -- 2.39.2