From c58fd5039f8dcef1faf64138f6b2ae82341043fa Mon Sep 17 00:00:00 2001 From: Alan Knowles Date: Thu, 29 Jul 2021 14:21:36 +0800 Subject: [PATCH] sync --- Roo/bootstrap/PhoneInput.js | 4 +- Roo/bootstrap/panel/Content.js | 6 +- docs/json/roodata.json | 213033 ++++++++++++++- docs/src/Roo_BasicDialog.js.html | 137 +- docs/src/Roo_BorderLayout.js.html | 19 +- docs/src/Roo_Button.js.html | 2 +- docs/src/Roo_ContentPanel.js.html | 19 +- docs/src/Roo_PagingToolbar.js.html | 1 + docs/src/Roo_Toolbar.js.html | 6 +- docs/src/Roo_bootstrap_Body.js.html | 3 + docs/src/Roo_bootstrap_Calendar.js.html | 5 + docs/src/Roo_bootstrap_Card.js.html | 1 + docs/src/Roo_bootstrap_Column.js.html | 1 + docs/src/Roo_bootstrap_Component.js.html | 2 + docs/src/Roo_bootstrap_Container.js.html | 2 + docs/src/Roo_bootstrap_Element.js.html | 4 +- docs/src/Roo_bootstrap_Form.js.html | 1 + docs/src/Roo_bootstrap_Link.js.html | 4 +- docs/src/Roo_bootstrap_Modal.js.html | 3 + docs/src/Roo_bootstrap_PhoneInput.js.html | 4 +- docs/src/Roo_bootstrap_Popover.js.html | 2 + docs/src/Roo_bootstrap_Row.js.html | 1 + docs/src/Roo_bootstrap_TabPanel.js.html | 1 + docs/src/Roo_bootstrap_Table.js.html | 4 +- docs/src/Roo_bootstrap_layout_Border.js.html | 1 + docs/src/Roo_bootstrap_panel_Content.js.html | 8 +- docs/src/Roo_data_DataProxy.js.html | 1 + docs/src/Roo_data_DataReader.js.html | 1 + docs/src/Roo_data_SimpleStore.js.html | 2 + docs/src/Roo_data_Store.js.html | 4 +- docs/src/Roo_form_ComboBoxArray.js.html | 2 +- docs/src/Roo_form_Form.js.html | 7 +- docs/src/Roo_form_Layout.js.html | 3 + docs/src/Roo_grid_AbstractGridView.js.html | 8 +- .../Roo_grid_AbstractSelectionModel.js.html | 1 + docs/src/Roo_grid_Grid.js.html | 15 + docs/src/Roo_menu_Adapter.js.html | 1 + docs/src/Roo_menu_BaseItem.js.html | 1 + docs/src/Roo_menu_Item.js.html | 5 +- docs/src/Roo_menu_Menu.js.html | 1 + docs/src/Roo_tree_TreeEditor.js.html | 2 +- docs/src/Roo_tree_TreePanel.js.html | 6 +- docs/symbols/Array.json | 30 +- docs/symbols/Date.json | 128 +- docs/symbols/Function.json | 37 +- docs/symbols/Number.json | 9 +- docs/symbols/Roo.Ajax.json | 123 +- docs/symbols/Roo.BasicDialog.json | 348 +- docs/symbols/Roo.BasicLayoutRegion.json | 193 +- docs/symbols/Roo.BorderLayout.json | 225 +- docs/symbols/Roo.BoxComponent.json | 278 +- docs/symbols/Roo.Button.json | 257 +- docs/symbols/Roo.CalendarPanel.json | 218 +- docs/symbols/Roo.ColorPalette.json | 214 +- docs/symbols/Roo.Component.json | 214 +- docs/symbols/Roo.ComponentMgr.json | 30 +- docs/symbols/Roo.CompositeElement.json | 93 +- docs/symbols/Roo.CompositeElementLite.json | 93 +- docs/symbols/Roo.ContentPanel.json | 252 +- docs/symbols/Roo.DDView.json | 98 +- docs/symbols/Roo.DatePicker.json | 279 +- docs/symbols/Roo.DialogManager.json | 30 +- docs/symbols/Roo.Document.json | 75 +- docs/symbols/Roo.DomHelper.json | 65 +- docs/symbols/Roo.DomQuery.json | 51 +- docs/symbols/Roo.DomTemplate.json | 95 +- docs/symbols/Roo.Editor.json | 296 +- docs/symbols/Roo.Element.json | 975 +- docs/symbols/Roo.EventManager.json | 58 +- docs/symbols/Roo.EventObject.json | 100 +- docs/symbols/Roo.Fx.json | 154 +- docs/symbols/Roo.GridPanel.json | 251 +- docs/symbols/Roo.HtmlEditorCore.json | 340 +- docs/symbols/Roo.JsonView.json | 302 +- docs/symbols/Roo.KeyMap.json | 37 +- docs/symbols/Roo.KeyNav.json | 25 +- docs/symbols/Roo.Layer.json | 1003 +- docs/symbols/Roo.LayoutDialog.json | 540 +- docs/symbols/Roo.LayoutManager.json | 133 +- docs/symbols/Roo.LayoutRegion.json | 309 +- docs/symbols/Roo.LoadMask.json | 25 +- docs/symbols/Roo.MasterTemplate.json | 109 +- docs/symbols/Roo.NestedLayoutPanel.json | 253 +- docs/symbols/Roo.PagingToolbar.json | 145 +- docs/symbols/Roo.QuickTips.json | 89 +- docs/symbols/Roo.ReaderLayout.json | 225 +- docs/symbols/Roo.Resizable.json | 196 +- docs/symbols/Roo.Shadow.json | 43 +- .../Roo.SplitBar.AbsoluteLayoutAdapter.json | 16 +- .../Roo.SplitBar.BasicLayoutAdapter.json | 16 +- docs/symbols/Roo.SplitBar.json | 143 +- docs/symbols/Roo.SplitButton.json | 264 +- docs/symbols/Roo.SplitLayoutRegion.json | 316 +- docs/symbols/Roo.TabPanel.json | 202 +- docs/symbols/Roo.TabPanelItem.json | 196 +- docs/symbols/Roo.Template.json | 81 +- docs/symbols/Roo.Toolbar.Button.json | 247 +- docs/symbols/Roo.Toolbar.Fill.json | 60 +- docs/symbols/Roo.Toolbar.Item.json | 62 +- docs/symbols/Roo.Toolbar.Separator.json | 60 +- docs/symbols/Roo.Toolbar.Spacer.json | 60 +- docs/symbols/Roo.Toolbar.SplitButton.json | 262 +- docs/symbols/Roo.Toolbar.TextItem.json | 63 +- docs/symbols/Roo.Toolbar.json | 116 +- docs/symbols/Roo.TreePanel.json | 244 +- .../Roo.UpdateManager.BasicRenderer.json | 9 +- docs/symbols/Roo.UpdateManager.defaults.json | 2 + docs/symbols/Roo.UpdateManager.json | 171 +- docs/symbols/Roo.View.json | 255 +- docs/symbols/Roo.XComponent.event.events.json | 2 + docs/symbols/Roo.XComponent.json | 139 +- docs/symbols/Roo.XTemplate.json | 88 +- docs/symbols/Roo.bootstrap.Alert.json | 312 +- .../Roo.bootstrap.BezierSignature.json | 288 +- docs/symbols/Roo.bootstrap.Body.json | 261 +- docs/symbols/Roo.bootstrap.Brick.json | 283 +- docs/symbols/Roo.bootstrap.Button.json | 413 +- docs/symbols/Roo.bootstrap.ButtonGroup.json | 283 +- .../symbols/Roo.bootstrap.ButtonUploader.json | 431 +- docs/symbols/Roo.bootstrap.Calendar.json | 299 +- docs/symbols/Roo.bootstrap.Card.json | 558 +- docs/symbols/Roo.bootstrap.CardFooter.json | 284 +- docs/symbols/Roo.bootstrap.CardHeader.json | 284 +- docs/symbols/Roo.bootstrap.CardImageTop.json | 284 +- docs/symbols/Roo.bootstrap.CardUploader.json | 428 +- docs/symbols/Roo.bootstrap.CheckBox.json | 580 +- docs/symbols/Roo.bootstrap.Column.json | 323 +- docs/symbols/Roo.bootstrap.ComboBox.json | 854 +- docs/symbols/Roo.bootstrap.Component.json | 263 +- docs/symbols/Roo.bootstrap.Container.json | 361 +- docs/symbols/Roo.bootstrap.DateField.json | 583 +- .../symbols/Roo.bootstrap.DateSplitField.json | 344 +- .../Roo.bootstrap.DocumentManager.json | 360 +- .../symbols/Roo.bootstrap.DocumentSlider.json | 273 +- .../symbols/Roo.bootstrap.DocumentViewer.json | 289 +- docs/symbols/Roo.bootstrap.DropTarget.json | 286 +- docs/symbols/Roo.bootstrap.Element.json | 288 +- docs/symbols/Roo.bootstrap.FieldLabel.json | 327 +- docs/symbols/Roo.bootstrap.Form.json | 383 +- docs/symbols/Roo.bootstrap.Graph.json | 286 +- docs/symbols/Roo.bootstrap.Header.json | 274 +- docs/symbols/Roo.bootstrap.HtmlEditor.json | 631 +- docs/symbols/Roo.bootstrap.Img.json | 314 +- docs/symbols/Roo.bootstrap.Input.json | 547 +- docs/symbols/Roo.bootstrap.LayoutMasonry.json | 341 +- .../Roo.bootstrap.LayoutMasonryAuto.json | 309 +- docs/symbols/Roo.bootstrap.Link.json | 296 +- .../symbols/Roo.bootstrap.LocationPicker.json | 359 +- docs/symbols/Roo.bootstrap.Markdown.json | 559 +- docs/symbols/Roo.bootstrap.MasonryBrick.json | 320 +- docs/symbols/Roo.bootstrap.Menu.json | 326 +- docs/symbols/Roo.bootstrap.MenuItem.json | 286 +- docs/symbols/Roo.bootstrap.MenuMgr.json | 16 +- docs/symbols/Roo.bootstrap.MenuSeparator.json | 261 +- docs/symbols/Roo.bootstrap.MessageBar.json | 287 +- docs/symbols/Roo.bootstrap.MessageBox.json | 79 +- docs/symbols/Roo.bootstrap.Modal.json | 347 +- docs/symbols/Roo.bootstrap.MoneyField.json | 875 +- docs/symbols/Roo.bootstrap.MonthField.json | 540 +- docs/symbols/Roo.bootstrap.NavGroup.json | 336 +- docs/symbols/Roo.bootstrap.NavHeaderbar.json | 354 +- docs/symbols/Roo.bootstrap.NavItem.json | 352 +- .../symbols/Roo.bootstrap.NavProgressBar.json | 265 +- .../Roo.bootstrap.NavProgressItem.json | 292 +- docs/symbols/Roo.bootstrap.NavSidebar.json | 277 +- .../symbols/Roo.bootstrap.NavSidebarItem.json | 350 +- docs/symbols/Roo.bootstrap.NavSimplebar.json | 329 +- docs/symbols/Roo.bootstrap.Navbar.json | 279 +- docs/symbols/Roo.bootstrap.NumberField.json | 567 +- docs/symbols/Roo.bootstrap.Pagination.json | 267 +- .../symbols/Roo.bootstrap.PaginationItem.json | 286 +- docs/symbols/Roo.bootstrap.PagingToolbar.json | 361 +- docs/symbols/Roo.bootstrap.PhoneInput.json | 575 +- docs/symbols/Roo.bootstrap.Popover.json | 307 +- docs/symbols/Roo.bootstrap.PopoverNav.json | 327 +- docs/symbols/Roo.bootstrap.Progress.json | 267 +- docs/symbols/Roo.bootstrap.ProgressBar.json | 287 +- docs/symbols/Roo.bootstrap.Radio.json | 267 +- docs/symbols/Roo.bootstrap.RadioSet.json | 554 +- docs/symbols/Roo.bootstrap.Row.json | 261 +- docs/symbols/Roo.bootstrap.SecurePass.json | 540 +- docs/symbols/Roo.bootstrap.Slider.json | 261 +- ...tstrap.SplitBar.AbsoluteLayoutAdapter.json | 16 +- ...bootstrap.SplitBar.BasicLayoutAdapter.json | 16 +- docs/symbols/Roo.bootstrap.SplitBar.json | 143 +- docs/symbols/Roo.bootstrap.TabGroup.json | 375 +- docs/symbols/Roo.bootstrap.TabPanel.json | 287 +- docs/symbols/Roo.bootstrap.Table.json | 462 +- docs/symbols/Roo.bootstrap.TableBody.json | 273 +- docs/symbols/Roo.bootstrap.TableCell.json | 306 +- docs/symbols/Roo.bootstrap.TableRow.json | 273 +- docs/symbols/Roo.bootstrap.TextArea.json | 556 +- docs/symbols/Roo.bootstrap.TimeField.json | 540 +- docs/symbols/Roo.bootstrap.Tooltip.json | 9 +- docs/symbols/Roo.bootstrap.TriggerField.json | 563 +- docs/symbols/Roo.bootstrap.UploadCropbox.json | 359 +- .../Roo.bootstrap.breadcrumb.Item.json | 274 +- .../symbols/Roo.bootstrap.breadcrumb.Nav.json | 261 +- docs/symbols/Roo.bootstrap.breadcrumb.json | 2 + .../symbols/Roo.bootstrap.dash.NumberBox.json | 276 +- docs/symbols/Roo.bootstrap.dash.TabBox.json | 294 +- docs/symbols/Roo.bootstrap.dash.TabPane.json | 281 +- docs/symbols/Roo.bootstrap.dash.json | 2 + ....bootstrap.htmleditor.ToolbarStandard.json | 15 +- docs/symbols/Roo.bootstrap.htmleditor.json | 2 + docs/symbols/Roo.bootstrap.json | 2 + docs/symbols/Roo.bootstrap.layout.Basic.json | 154 +- docs/symbols/Roo.bootstrap.layout.Border.json | 353 +- .../symbols/Roo.bootstrap.layout.Manager.json | 312 +- docs/symbols/Roo.bootstrap.layout.Region.json | 288 +- docs/symbols/Roo.bootstrap.layout.Split.json | 316 +- docs/symbols/Roo.bootstrap.layout.json | 2 + docs/symbols/Roo.bootstrap.menu.Item.json | 303 +- docs/symbols/Roo.bootstrap.menu.Menu.json | 293 +- .../symbols/Roo.bootstrap.menu.Separator.json | 261 +- docs/symbols/Roo.bootstrap.menu.json | 2 + docs/symbols/Roo.bootstrap.panel.Content.json | 248 +- docs/symbols/Roo.bootstrap.panel.Grid.json | 246 +- docs/symbols/Roo.bootstrap.panel.Nest.json | 250 +- docs/symbols/Roo.bootstrap.panel.TabItem.json | 196 +- docs/symbols/Roo.bootstrap.panel.Tabs.json | 202 +- docs/symbols/Roo.bootstrap.panel.json | 2 + docs/symbols/Roo.data.ArrayReader.json | 22 +- docs/symbols/Roo.data.Connection.json | 129 +- docs/symbols/Roo.data.DataProxy.json | 14 +- docs/symbols/Roo.data.DataReader.json | 9 +- docs/symbols/Roo.data.HttpProxy.json | 43 +- docs/symbols/Roo.data.JsonReader.json | 38 +- docs/symbols/Roo.data.JsonStore.json | 334 +- docs/symbols/Roo.data.MemoryProxy.json | 9 +- docs/symbols/Roo.data.Node.json | 253 +- docs/symbols/Roo.data.Record.json | 44 +- docs/symbols/Roo.data.ScriptTagProxy.json | 28 +- docs/symbols/Roo.data.SimpleStore.json | 338 +- docs/symbols/Roo.data.SortTypes.json | 51 +- docs/symbols/Roo.data.Store.json | 351 +- docs/symbols/Roo.data.Tree.json | 128 +- docs/symbols/Roo.data.XmlReader.json | 35 +- docs/symbols/Roo.data.json | 2 + docs/symbols/Roo.dd.DD.json | 404 +- docs/symbols/Roo.dd.DDProxy.json | 418 +- docs/symbols/Roo.dd.DDTarget.json | 369 +- docs/symbols/Roo.dd.DragDrop.json | 369 +- docs/symbols/Roo.dd.DragDropMgr.json | 198 +- docs/symbols/Roo.dd.DragSource.json | 494 +- docs/symbols/Roo.dd.DragZone.json | 521 +- docs/symbols/Roo.dd.DropTarget.json | 431 +- docs/symbols/Roo.dd.DropZone.json | 472 +- docs/symbols/Roo.dd.Registry.json | 44 +- docs/symbols/Roo.dd.ScrollManager.json | 23 +- docs/symbols/Roo.dd.StatusProxy.json | 78 +- docs/symbols/Roo.dd.json | 2 + docs/symbols/Roo.form.Action.json | 2 + docs/symbols/Roo.form.BasicForm.json | 281 +- docs/symbols/Roo.form.Checkbox.json | 459 +- docs/symbols/Roo.form.Column.json | 225 +- docs/symbols/Roo.form.ComboBox.json | 723 +- docs/symbols/Roo.form.ComboBoxArray.Item.json | 274 +- docs/symbols/Roo.form.ComboBoxArray.json | 541 +- docs/symbols/Roo.form.ComboCheck.json | 709 +- docs/symbols/Roo.form.ComboNested.json | 709 +- docs/symbols/Roo.form.DateField.json | 561 +- docs/symbols/Roo.form.DayPicker.json | 443 +- docs/symbols/Roo.form.DisplayField.json | 456 +- docs/symbols/Roo.form.FCKeditor.json | 530 +- docs/symbols/Roo.form.Field.json | 457 +- docs/symbols/Roo.form.FieldSet.json | 225 +- docs/symbols/Roo.form.Form.json | 396 +- docs/symbols/Roo.form.GridField.json | 449 +- docs/symbols/Roo.form.Hidden.json | 520 +- .../Roo.form.HtmlEditor.ToolbarContext.json | 15 +- .../Roo.form.HtmlEditor.ToolbarStandard.json | 27 +- docs/symbols/Roo.form.HtmlEditor.json | 510 +- docs/symbols/Roo.form.Layout.json | 222 +- docs/symbols/Roo.form.MonthField.json | 561 +- docs/symbols/Roo.form.NumberField.json | 547 +- docs/symbols/Roo.form.Radio.json | 464 +- docs/symbols/Roo.form.Row.json | 228 +- docs/symbols/Roo.form.Select.json | 705 +- docs/symbols/Roo.form.Signature.json | 492 +- docs/symbols/Roo.form.TextArea.json | 523 +- docs/symbols/Roo.form.TextField.json | 522 +- docs/symbols/Roo.form.TextItem.json | 280 +- docs/symbols/Roo.form.TriggerField.json | 524 +- docs/symbols/Roo.form.VTypes.json | 30 +- docs/symbols/Roo.form.json | 2 + docs/symbols/Roo.grid.AbstractGridView.json | 405 +- .../Roo.grid.AbstractSelectionModel.json | 96 +- docs/symbols/Roo.grid.Calendar.json | 152 +- docs/symbols/Roo.grid.CellSelectionModel.json | 154 +- docs/symbols/Roo.grid.ColumnModel.json | 363 +- docs/symbols/Roo.grid.EditorGrid.json | 348 +- docs/symbols/Roo.grid.Grid.json | 377 +- docs/symbols/Roo.grid.GridEditor.json | 289 +- docs/symbols/Roo.grid.GridView.json | 152 +- docs/symbols/Roo.grid.PropertyGrid.json | 496 +- docs/symbols/Roo.grid.RowSelectionModel.json | 245 +- docs/symbols/Roo.grid.SplitDragZone.json | 418 +- docs/symbols/Roo.grid.json | 2 + docs/symbols/Roo.json | 177 +- docs/symbols/Roo.lib.Ajax.json | 9 +- docs/symbols/Roo.lib.Dom.json | 2 + docs/symbols/Roo.lib.json | 2 + docs/symbols/Roo.menu.Adapter.json | 218 +- docs/symbols/Roo.menu.BaseItem.json | 224 +- docs/symbols/Roo.menu.CheckItem.json | 270 +- docs/symbols/Roo.menu.ColorItem.json | 218 +- docs/symbols/Roo.menu.ColorMenu.json | 211 +- docs/symbols/Roo.menu.DateItem.json | 218 +- docs/symbols/Roo.menu.DateMenu.json | 211 +- docs/symbols/Roo.menu.Item.json | 246 +- docs/symbols/Roo.menu.Menu.json | 223 +- docs/symbols/Roo.menu.MenuMgr.json | 16 +- docs/symbols/Roo.menu.Separator.json | 221 +- docs/symbols/Roo.menu.TextItem.json | 224 +- docs/symbols/Roo.menu.json | 2 + docs/symbols/Roo.state.CookieProvider.json | 51 +- docs/symbols/Roo.state.Manager.json | 37 +- docs/symbols/Roo.state.Provider.json | 41 +- docs/symbols/Roo.state.json | 2 + docs/symbols/Roo.tree.AsyncTreeNode.json | 436 +- docs/symbols/Roo.tree.ColumnTree.json | 12 +- .../Roo.tree.DefaultSelectionModel.json | 132 +- .../symbols/Roo.tree.MultiSelectionModel.json | 114 +- docs/symbols/Roo.tree.TreeEditor.json | 309 +- docs/symbols/Roo.tree.TreeFilter.json | 23 +- docs/symbols/Roo.tree.TreeLoader.json | 122 +- docs/symbols/Roo.tree.TreeNode.json | 428 +- docs/symbols/Roo.tree.TreeNodeUI.json | 2 + docs/symbols/Roo.tree.TreePanel.json | 334 +- docs/symbols/Roo.tree.TreeSorter.json | 20 +- docs/symbols/Roo.tree.json | 2 + docs/symbols/Roo.util.CSS.json | 51 +- docs/symbols/Roo.util.ClickRepeater.json | 108 +- docs/symbols/Roo.util.Clipboard.json | 2 + docs/symbols/Roo.util.DelayedTask.json | 2 + docs/symbols/Roo.util.Format.json | 114 +- docs/symbols/Roo.util.JSON.json | 2 + docs/symbols/Roo.util.MixedCollection.json | 294 +- docs/symbols/Roo.util.Observable.json | 75 +- .../Roo.util.TextMetrics.Instance.json | 2 + docs/symbols/Roo.util.TextMetrics.json | 16 +- docs/symbols/Roo.util.json | 2 + docs/symbols/String.json | 37 +- docs/symbols/_global_.json | 58 +- docs/symbols/this.json | 2 + docs/tree.json | 2 +- 347 files changed, 255381 insertions(+), 32505 deletions(-) diff --git a/Roo/bootstrap/PhoneInput.js b/Roo/bootstrap/PhoneInput.js index fae2356670..d3d82f13b0 100644 --- a/Roo/bootstrap/PhoneInput.js +++ b/Roo/bootstrap/PhoneInput.js @@ -24,7 +24,9 @@ Roo.bootstrap.PhoneInput = function(config) { }; Roo.extend(Roo.bootstrap.PhoneInput, Roo.bootstrap.TriggerField, { - + /** + * @cfg {Roo.data.Store} store [required] The data store to which this combo is bound (defaults to undefined) + */ listWidth: undefined, selectedClass: 'active', diff --git a/Roo/bootstrap/panel/Content.js b/Roo/bootstrap/panel/Content.js index 9b24d6c701..7ad2d4912b 100644 --- a/Roo/bootstrap/panel/Content.js +++ b/Roo/bootstrap/panel/Content.js @@ -25,7 +25,7 @@ * @cfg {String} title The title for this panel * @cfg {Array} adjustments Values to add to the width/height when doing a {@link #fitToFrame} (default is [0, 0]) * @cfg {String} url Calls {@link #setUrl} with this value - * @cfg {String} region (center|north|south|east|west) which region to put this panel on (when used with xtype constructors) + * @cfg {String} region [required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors) * @cfg {String/Object} params When used with {@link #url}, calls {@link #setUrl} with this value * @cfg {Boolean} loadOnce When used with {@link #url}, calls {@link #setUrl} with this value * @cfg {String} content Raw content to fill content panel with (uses setContent on construction.) @@ -36,10 +36,8 @@ * @constructor * Create a new ContentPanel. - * @param {String/HTMLElement/Roo.Element} el The container element for this panel * @param {String/Object} config A string to set only the title or a config object - * @param {String} content (optional) Set the HTML content for this panel - * @param {String} region (optional) Used by xtype constructors to add to regions. (values center,east,west,south,north) + */ Roo.bootstrap.panel.Content = function( config){ diff --git a/docs/json/roodata.json b/docs/json/roodata.json index fb34ff95eb..bfc6fd37df 100644 --- a/docs/json/roodata.json +++ b/docs/json/roodata.json @@ -9,7 +9,25 @@ "desc" : "equals", "sig" : "(o)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "o", + "type" : "Array", + "desc" : "The array to compare to", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "indexOf", @@ -17,7 +35,31 @@ "desc" : "Checks whether or not the specified object exists in the array.", "sig" : "(o)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "o", + "type" : "Object", + "desc" : "The object to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The index of o in the array (or -1 if it is not found)" + } + ] }, { "name" : "map", @@ -25,7 +67,25 @@ "desc" : "Map (JS 1.6 compatibility)", "sig" : "(function() {\n\n})", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "function", + "type" : "Function", + "desc" : "to call", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "remove", @@ -33,7 +93,25 @@ "desc" : "Removes the specified object from the array. If the object is not found nothing happens.", "sig" : "(o)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "o", + "type" : "Object", + "desc" : "The object to remove", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -47,7 +125,37 @@ "desc" : "Provides a convenient method of performing basic date arithmetic. This method\ndoes not modify the Date instance being called - it creates and returns\na new Date instance containing the resulting date value.\n\nExamples:\n
\n//Basic usage:\nvar dt = new Date('10/29/2006').add(Date.DAY, 5);\ndocument.write(dt); //returns 'Fri Oct 06 2006 00:00:00'\n\n//Negative values will subtract correctly:\nvar dt2 = new Date('10/1/2006').add(Date.DAY, -5);\ndocument.write(dt2); //returns 'Tue Sep 26 2006 00:00:00'\n\n//You can even chain several calls together in one line!\nvar dt3 = new Date('10/1/2006').add(Date.DAY, 5).add(Date.HOUR, 8).add(Date.MINUTE, -30);\ndocument.write(dt3); //returns 'Fri Oct 06 2006 07:30:00'\n 
", "sig" : "(interval, value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "interval", + "type" : "String", + "desc" : "A valid date interval enum value", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Number", + "desc" : "The amount to add to the current date", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Date", + "desc" : "The new Date instance" + } + ] }, { "name" : "clearTime", @@ -55,7 +163,31 @@ "desc" : "Clears any time information from this date", "sig" : "(clone)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "clone", + "type" : "Boolean", + "desc" : "true to create a clone of this date, clear the time and return it", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Date", + "desc" : "this or the clone" + } + ] }, { "name" : "clone", @@ -63,7 +195,24 @@ "desc" : "Creates and returns a new Date instance with the exact same date value as the called instance.\nDates are copied and passed by reference, so if a copied date variable is modified later, the original\nvariable will also be changed. When the intention is to create a new variable that will not\nmodify the original instance, you should create a clone.\n\nExample of correctly cloning a date:\n
\n//wrong way:\nvar orig = new Date('10/1/2006');\nvar copy = orig;\ncopy.setDate(5);\ndocument.write(orig);  //returns 'Thu Oct 05 2006'!\n\n//correct way:\nvar orig = new Date('10/1/2006');\nvar copy = orig.clone();\ncopy.setDate(5);\ndocument.write(orig);  //returns 'Thu Oct 01 2006'\n
", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Date", + "desc" : "The new Date instance" + } + ] }, { "name" : "format", @@ -71,7 +220,31 @@ "desc" : "Formats a date given the supplied format string", "sig" : "(format)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "format", + "type" : "String", + "desc" : "The format string", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The formatted date" + } + ] }, { "name" : "getDayOfYear", @@ -79,7 +252,24 @@ "desc" : "Get the numeric day number of the year, adjusted for leap year.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "0 through 364 (365 in leap years)" + } + ] }, { "name" : "getDaysInMonth", @@ -87,7 +277,24 @@ "desc" : "Get the number of days in the current month, adjusted for leap year.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The number of days in the month" + } + ] }, { "name" : "getElapsed", @@ -95,7 +302,31 @@ "desc" : "Returns the number of milliseconds between this date and date", "sig" : "(date)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "date", + "type" : "Date", + "desc" : "(optional) Defaults to now", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The diff in milliseconds" + } + ] }, { "name" : "getFirstDateOfMonth", @@ -103,7 +334,24 @@ "desc" : "Get the first date of this date's month", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Date", + "desc" : "" + } + ] }, { "name" : "getFirstDayOfMonth", @@ -111,7 +359,24 @@ "desc" : "Get the first day of the current month, adjusted for leap year. The returned value\nis the numeric day index within the week (0-6) which can be used in conjunction with\nthe {@link #monthNames} array to retrieve the textual day name.\nExample:\n
\nvar dt = new Date('1/10/2007');\ndocument.write(Date.dayNames[dt.getFirstDayOfMonth()]); //output: 'Monday'\n
", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The day number (0-6)" + } + ] }, { "name" : "getGMTColonOffset", @@ -119,7 +384,24 @@ "desc" : "Get the offset from GMT of the current date (equivalent to the format specifier 'P').", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "2-characters representing hours and 2-characters representing minutes\nseperated by a colon and prefixed with + or - (e.g. '-06:00')" + } + ] }, { "name" : "getGMTOffset", @@ -127,7 +409,24 @@ "desc" : "Get the offset from GMT of the current date (equivalent to the format specifier 'O').", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The 4-character offset string prefixed with + or - (e.g. '-0600')" + } + ] }, { "name" : "getLastDateOfMonth", @@ -135,7 +434,24 @@ "desc" : "Get the last date of this date's month", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Date", + "desc" : "" + } + ] }, { "name" : "getLastDayOfMonth", @@ -143,7 +459,24 @@ "desc" : "Get the last day of the current month, adjusted for leap year. The returned value\nis the numeric day index within the week (0-6) which can be used in conjunction with\nthe {@link #monthNames} array to retrieve the textual day name.\nExample:\n
\nvar dt = new Date('1/10/2007');\ndocument.write(Date.dayNames[dt.getLastDayOfMonth()]); //output: 'Wednesday'\n
", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The day number (0-6)" + } + ] }, { "name" : "getSuffix", @@ -151,7 +484,24 @@ "desc" : "Get the English ordinal suffix of the current day (equivalent to the format specifier 'S').", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "'st, 'nd', 'rd' or 'th'" + } + ] }, { "name" : "getTimezone", @@ -159,7 +509,24 @@ "desc" : "Get the timezone abbreviation of the current date (equivalent to the format specifier 'T').", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The abbreviated timezone name (e.g. 'CST')" + } + ] }, { "name" : "getWeekOfYear", @@ -167,7 +534,24 @@ "desc" : "Get the string representation of the numeric week number of the year\n(equivalent to the format specifier 'W').", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "'00' through '52'" + } + ] }, { "name" : "isLeapYear", @@ -175,7 +559,24 @@ "desc" : "Whether or not the current date is in a leap year.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the current date is in a leap year, else false" + } + ] }, { "name" : "parseDate", @@ -183,7 +584,37 @@ "desc" : "Parses the passed string using the specified format. Note that this function expects dates in normal calendar\nformat, meaning that months are 1-based (1 = January) and not zero-based like in JavaScript dates. Any part of\nthe date format that is not specified will default to the current date value for that part. Time parts can also\nbe specified, but default to 0. Keep in mind that the input date string must precisely match the specified format\nstring or the parse operation will fail.\nExample Usage:\n
\n//dt = Fri May 25 2007 (current date)\nvar dt = new Date();\n\n//dt = Thu May 25 2006 (today's month/day in 2006)\ndt = Date.parseDate(\"2006\", \"Y\");\n\n//dt = Sun Jan 15 2006 (all date parts specified)\ndt = Date.parseDate(\"2006-1-15\", \"Y-m-d\");\n\n//dt = Sun Jan 15 2006 15:20:01 GMT-0600 (CST)\ndt = Date.parseDate(\"2006-1-15 3:20:01 PM\", \"Y-m-d h:i:s A\" );\n
", "sig" : "(input, format)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "input", + "type" : "String", + "desc" : "The unparsed date as a string", + "isOptional" : false + }, + { + "name" : "format", + "type" : "String", + "desc" : "The format the date is in", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Date", + "desc" : "The parsed date" + } + ] } ] }, @@ -197,7 +628,24 @@ "desc" : "Creates a callback that passes arguments[0], arguments[1], arguments[2], ...\nCall directly on any function. Example: myFunction.createCallback(myarg, myarg2)\nWill create a function that is bound to those 2 args.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Function", + "desc" : "The new function" + } + ] }, { "name" : "createDelegate", @@ -205,7 +653,43 @@ "desc" : "Creates a delegate (callback) that sets the scope to obj.\nCall directly on any function. Example: this.myFunction.createDelegate(this)\nWill create a function that is automatically scoped to this.", "sig" : "(obj, args, appendArgs)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "obj", + "type" : "Object", + "desc" : "(optional) The object for which the scope is set", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Array", + "desc" : "(optional) Overrides arguments for the call. (Defaults to the arguments passed by the caller)", + "isOptional" : false + }, + { + "name" : "appendArgs", + "type" : "Boolean/Number", + "desc" : "(optional) if True args are appended to call args instead of overriding,\n if a number the args are inserted at the specified position", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Function", + "desc" : "The new function" + } + ] }, { "name" : "createInterceptor", @@ -213,7 +697,37 @@ "desc" : "Creates an interceptor function. The passed fcn is called before the original one. If it returns false, the original one is not called.\nThe resulting function returns the results of the original function.\nThe passed fcn is called with the parameters of the original function.", "sig" : "(fcn, scope)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fcn", + "type" : "Function", + "desc" : "The function to call before the original", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the passed fcn (Defaults to scope of original function or window)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Function", + "desc" : "The new function" + } + ] }, { "name" : "createSequence", @@ -221,7 +735,37 @@ "desc" : "Create a combined function call sequence of the original function + the passed function.\nThe resulting function returns the results of the original function.\nThe passed fcn is called with the parameters of the original function", "sig" : "(fcn, scope)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fcn", + "type" : "Function", + "desc" : "The function to sequence", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the passed fcn (Defaults to scope of original function or window)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Function", + "desc" : "The new function" + } + ] }, { "name" : "defer", @@ -229,7 +773,49 @@ "desc" : "Calls this function after the number of millseconds specified.", "sig" : "(millis, obj, args, appendArgs)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "millis", + "type" : "Number", + "desc" : "The number of milliseconds for the setTimeout call (if 0 the function is executed immediately)", + "isOptional" : false + }, + { + "name" : "obj", + "type" : "Object", + "desc" : "(optional) The object for which the scope is set", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Array", + "desc" : "(optional) Overrides arguments for the call. (Defaults to the arguments passed by the caller)", + "isOptional" : false + }, + { + "name" : "appendArgs", + "type" : "Boolean/Number", + "desc" : "(optional) if True args are appended to call args instead of overriding,\n if a number the args are inserted at the specified position", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The timeout id that can be used with clearTimeout" + } + ] } ] }, @@ -243,7 +829,37 @@ "desc" : "Checks whether or not the current number is within a desired range. If the number is already within the\nrange it is returned, otherwise the min or max value is returned depending on which side of the range is\nexceeded. Note that this method returns the constrained value but does not change the current number.", "sig" : "(min, max)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "min", + "type" : "Number", + "desc" : "The minimum number in the range", + "isOptional" : false + }, + { + "name" : "max", + "type" : "Number", + "desc" : "The maximum number in the range", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The constrained value if outside the range, otherwise the current value" + } + ] } ] }, @@ -257,7 +873,25 @@ "desc" : "Applies event listeners to elements by selectors when the document is ready.\nThe event name is specified with an @ suffix.\n
\nRoo.addBehaviors({\n   // add a listener for click on all anchors in element with id foo\n   '#foo a@click' : function(e, t){\n       // do something\n   },\n\n   // add the same listener to multiple selectors (separated by comma BEFORE the @)\n   '#foo a, #bar span.some-class@mouseover' : function(){\n       // do something\n   }\n});\n
", "sig" : "(obj)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "obj", + "type" : "Object", + "desc" : "The list of behaviors to apply", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "apply", @@ -265,7 +899,43 @@ "desc" : "Copies all the properties of config to obj.", "sig" : "(obj, config, defaults)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "obj", + "type" : "Object", + "desc" : "The receiver of the properties", + "isOptional" : false + }, + { + "name" : "config", + "type" : "Object", + "desc" : "The source of the properties", + "isOptional" : false + }, + { + "name" : "defaults", + "type" : "Object", + "desc" : "A different object that will also be applied for default values", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "returns obj" + } + ] }, { "name" : "applyIf", @@ -273,7 +943,37 @@ "desc" : "Copies all the properties of config to obj if they don't already exist.", "sig" : "(obj, config)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "obj", + "type" : "Object", + "desc" : "The receiver of the properties", + "isOptional" : false + }, + { + "name" : "config", + "type" : "Object", + "desc" : "The source of the properties", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "returns obj" + } + ] }, { "name" : "decode", @@ -281,7 +981,18 @@ "desc" : "Shorthand for {@link Roo.util.JSON#decode}", "sig" : "()\n{\n\n}", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "each", @@ -289,7 +1000,37 @@ "desc" : "Iterates an array calling the passed function with each item, stopping if your function returns false. If the\npassed array is not really an array, your function is called once with it.\nThe supplied function is called with (Object item, Number index, Array allItems).", "sig" : "(array, fn, scope)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "array", + "type" : "Array/NodeList/Mixed", + "desc" : "", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "encode", @@ -297,7 +1038,18 @@ "desc" : "Shorthand for {@link Roo.util.JSON#encode}", "sig" : "()\n{\n\n}", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "encodeURIComponent", @@ -305,7 +1057,31 @@ "desc" : "Safe version of encodeURIComponent", "sig" : "(data)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "data", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "escapeRe", @@ -313,7 +1089,31 @@ "desc" : "Escapes the passed string for use in a regular expression", "sig" : "(str)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "str", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "extend", @@ -321,7 +1121,37 @@ "desc" : "Extends one class with another class and optionally overrides members with the passed literal. This class\nalso adds the function \"override()\" to the class that can be used to override\nmembers on an instance.", "sig" : "(subclass, superclass, overrides)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "subclass", + "type" : "Object", + "desc" : "The class inheriting the functionality", + "isOptional" : false + }, + { + "name" : "superclass", + "type" : "Object", + "desc" : "The class being extended", + "isOptional" : false + }, + { + "name" : "overrides", + "type" : "Object", + "desc" : "(optional) A literal with members", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "factory", @@ -329,7 +1159,31 @@ "desc" : "Creates namespaces to be used for scoping variables and classes so that they are not global. Usage:\n
\nRoo.factory({ xns: Roo.data, xtype : 'Store', .....});\nRoo.factory(conf, Roo.data);\n
", "sig" : "(classname, namespace)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "classname", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "namespace", + "type" : "String", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fly", @@ -337,7 +1191,37 @@ "desc" : "Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -\nthe dom node can be overwritten by other code.\nShorthand of {@link Roo.Element#fly}", "sig" : "(el, named)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement", + "desc" : "The dom node or id", + "isOptional" : false + }, + { + "name" : "named", + "type" : "String", + "desc" : "(optional) Allows for creation of named reusable flyweights to\n prevent conflicts (e.g. internally Roo uses \"_internal\")", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "The shared Element object" + } + ] }, { "name" : "get", @@ -345,7 +1229,31 @@ "desc" : "Static method to retrieve Element objects. Uses simple caching to consistently return the same object.\nAutomatically fixes if an object was recreated with the same id via AJAX or DOM.\nShorthand of {@link Roo.Element#get}", "sig" : "(el)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM Node or an existing Element.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "The Element object" + } + ] }, { "name" : "getCmp", @@ -353,7 +1261,31 @@ "desc" : "Shorthand for {@link Roo.ComponentMgr#get}", "sig" : "(id)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Roo.Component" + } + ] }, { "name" : "getDom", @@ -361,7 +1293,31 @@ "desc" : "Return the dom node for the passed string (id), dom node, or Roo.Element", "sig" : "(el)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "HTMLElement" + } + ] }, { "name" : "getGridSize", @@ -369,7 +1325,18 @@ "desc" : "Find the current bootstrap width Grid size\nNote xs is the default for smaller.. - this is currently used by grids to render correct columns", "sig" : "()\n{\n\n}", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "id", @@ -377,7 +1344,37 @@ "desc" : "Generates unique ids. If the element already has an id, it is unchanged", "sig" : "(el, prefix)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "(optional) The element to generate an id for", + "isOptional" : false + }, + { + "name" : "prefix", + "type" : "String", + "desc" : "(optional) Id prefix (defaults \"Roo-gen\")", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The generated Id." + } + ] }, { "name" : "isEmpty", @@ -385,7 +1382,37 @@ "desc" : "Returns true if the passed value is null, undefined or an empty string (optional).", "sig" : "(value, allowBlank)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to test", + "isOptional" : false + }, + { + "name" : "allowBlank", + "type" : "Boolean", + "desc" : "(optional) Pass true if an empty string is not considered empty", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "onReady", @@ -393,7 +1420,37 @@ "desc" : "Fires when the document is ready (before onload and before images are loaded). Shorthand of {@link Roo.EventManager#onDocumentReady}.", "sig" : "(fn, scope, override)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "An object that becomes the scope of the handler", + "isOptional" : false + }, + { + "name" : "override", + "type" : "boolean", + "desc" : "If true, the obj passed in becomes\n the execution scope of the listener", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "override", @@ -401,7 +1458,31 @@ "desc" : "Adds a list of functions to the prototype of an existing class, overwriting any existing methods with the same name.\nUsage:
\nRoo.override(MyClass, {\n    newMethod1: function(){\n        // etc.\n    },\n    newMethod2: function(foo){\n        // etc.\n    }\n});\n 
", "sig" : "(origclass, overrides)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "origclass", + "type" : "Object", + "desc" : "The class to override", + "isOptional" : false + }, + { + "name" : "overrides", + "type" : "Object", + "desc" : "The list of functions to add to origClass. This should be specified as an object literal\ncontaining one or more methods.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "query", @@ -409,7 +1490,37 @@ "desc" : "Selects an array of DOM nodes by CSS/XPath selector. Shorthand of {@link Roo.DomQuery#select}", "sig" : "(path, root)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "path", + "type" : "String", + "desc" : "The selector/xpath query", + "isOptional" : false + }, + { + "name" : "root", + "type" : "Node", + "desc" : "(optional) The start of the query (defaults to document).", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "" + } + ] }, { "name" : "select", @@ -417,7 +1528,43 @@ "desc" : "Selects elements based on the passed CSS selector to enable working on them as 1.", "sig" : "(selector, unique, root)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "selector", + "type" : "String/Array", + "desc" : "The CSS selector or an array of elements", + "isOptional" : false + }, + { + "name" : "unique", + "type" : "Boolean", + "desc" : "(optional) true to create a unique Roo.Element for each element (defaults to a shared flyweight object)", + "isOptional" : false + }, + { + "name" : "root", + "type" : "HTMLElement/String", + "desc" : "(optional) The root element of the query or id of the root", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "CompositeElementLite/CompositeElement", + "desc" : "" + } + ] }, { "name" : "selectNode", @@ -425,7 +1572,37 @@ "desc" : "Selects a single element as a Roo Element\nThis is about as close as you can get to jQuery's $('do crazy stuff')", "sig" : "(selector, root)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "selector", + "type" : "String", + "desc" : "The selector/xpath query", + "isOptional" : false + }, + { + "name" : "root", + "type" : "Node", + "desc" : "(optional) The start of the query (defaults to document).", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] }, { "name" : "type", @@ -433,7 +1610,31 @@ "desc" : "Returns the type of object that is passed in. If the object passed in is null or undefined it\nreturn false otherwise it returns one of the following values:", "sig" : "(config)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "The config object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "unregister", @@ -11304,17 +37340,65 @@ "desc" : "Removes this quick tip from its element and destroys it.", "sig" : "(el)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The element from which the quick tip is to be removed.", + "isOptional" : false + } + ], + "returns" : [] } ] }, "Roo.ReaderLayout" : { "props" : [ + { + "name" : "center", + "type" : "Roo.LayoutRegion", + "desc" : "", + "memberOf" : "Roo.BorderLayout" + }, + { + "name" : "east", + "type" : "Roo.LayoutRegion", + "desc" : "", + "memberOf" : "Roo.BorderLayout" + }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and 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" : "north", + "type" : "Roo.LayoutRegion", + "desc" : "", + "memberOf" : "Roo.BorderLayout" + }, + { + "name" : "south", + "type" : "Roo.LayoutRegion", + "desc" : "", + "memberOf" : "Roo.BorderLayout" + }, + { + "name" : "west", + "type" : "Roo.LayoutRegion", + "desc" : "", + "memberOf" : "Roo.BorderLayout" } ], "events" : [ @@ -11323,28 +37407,86 @@ "type" : "function", "desc" : "Fires when a layout is performed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.LayoutManager" + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutManager", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "regioncollapsed", "type" : "function", "desc" : "Fires when a region is collapsed.", "sig" : "function (region)\n{\n\n}", - "memberOf" : "Roo.LayoutManager" + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The collapsed region", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "regionexpanded", "type" : "function", "desc" : "Fires when a region is expanded.", "sig" : "function (region)\n{\n\n}", - "memberOf" : "Roo.LayoutManager" + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The expanded region", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "regionresized", "type" : "function", "desc" : "Fires when the user resizes a region.", "sig" : "function (region, newSize)\n{\n\n}", - "memberOf" : "Roo.LayoutManager" + "memberOf" : "Roo.LayoutManager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The resized region", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new size (width for east/west, height for north/south)", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -11354,7 +37496,37 @@ "desc" : "Adds a ContentPanel (or subclass) to this layout.", "sig" : "(target, panel)", "static" : false, - "memberOf" : "Roo.BorderLayout" + "memberOf" : "Roo.BorderLayout", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "target", + "type" : "String", + "desc" : "The target region key (north, south, east, west or center).", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The panel to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The added panel" + } + ] }, { "name" : "addEvents", @@ -11362,7 +37534,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -11370,7 +37560,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "addRegion", @@ -11378,7 +37604,37 @@ "desc" : "Creates and adds a new region if it doesn't already exist.", "sig" : "(target, config)", "static" : false, - "memberOf" : "Roo.BorderLayout" + "memberOf" : "Roo.BorderLayout", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "target", + "type" : "String", + "desc" : "The target region key (north, south, east, west or center).", + "isOptional" : false + }, + { + "name" : "config", + "type" : "Object", + "desc" : "The regions config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BorderLayoutRegion", + "desc" : "The new region" + } + ] }, { "name" : "addxtype", @@ -11386,7 +37642,25 @@ "desc" : "Adds a xtype elements to the layout.\n
\n\nlayout.addxtype({\n       xtype : 'ContentPanel',\n       region: 'west',\n       items: [ .... ]\n   }\n);\n\nlayout.addxtype({\n        xtype : 'NestedLayoutPanel',\n        region: 'west',\n        layout: {\n           center: { },\n           west: { }   \n        },\n        items : [ ... list of content panels or nested layout panels.. ]\n   }\n);\n
", "sig" : "(cfg)", "static" : false, - "memberOf" : "Roo.BorderLayout" + "memberOf" : "Roo.BorderLayout", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cfg", + "type" : "Object", + "desc" : "Xtype definition of item to add.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "batchAdd", @@ -11394,7 +37668,25 @@ "desc" : "Adds a batch of multiple ContentPanels dynamically by passing a special regions config object. This config\nobject should contain properties for each region to add ContentPanels to, and each property's value should be\na valid ContentPanel config object. Example:\n
\n// Create the main layout\nvar layout = new Roo.BorderLayout('main-ct', {\n    west: {\n        split:true,\n        minSize: 175,\n        titlebar: true\n    },\n    center: {\n        title:'Components'\n    }\n}, 'main-ct');\n\n// Create and add multiple ContentPanels at once via configs\nlayout.batchAdd({\n   west: {\n       id: 'source-files',\n       autoCreate:true,\n       title:'Ext Source Files',\n       autoScroll:true,\n       fitToFrame:true\n   },\n   center : {\n       el: cview,\n       autoScroll:true,\n       fitToFrame:true,\n       toolbar: tb,\n       resizeEl:'cbody'\n   }\n});\n
", "sig" : "(regions)", "static" : false, - "memberOf" : "Roo.BorderLayout" + "memberOf" : "Roo.BorderLayout", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "regions", + "type" : "Object", + "desc" : "An object containing ContentPanel configs by region name", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beginUpdate", @@ -11402,7 +37694,18 @@ "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.LayoutManager" + "memberOf" : "Roo.LayoutManager", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -11410,7 +37713,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "create", @@ -11418,7 +37751,31 @@ "desc" : "Shortcut for creating a new BorderLayout object and adding one or more ContentPanels to it in a single step, handling\nthe beginUpdate and endUpdate calls internally. The key to this method is the panels property that can be\nprovided with each region config, which allows you to add ContentPanel configs in addition to the region configs\nduring creation. The following code is equivalent to the constructor-based example at the beginning of this class:\n
\n// shorthand\nvar CP = Roo.ContentPanel;\n\nvar layout = Roo.BorderLayout.create({\n    north: {\n        initialSize: 25,\n        titlebar: false,\n        panels: [new CP(\"north\", \"North\")]\n    },\n    west: {\n        split:true,\n        initialSize: 200,\n        minSize: 175,\n        maxSize: 400,\n        titlebar: true,\n        collapsible: true,\n        panels: [new CP(\"west\", {title: \"West\"})]\n    },\n    east: {\n        split:true,\n        initialSize: 202,\n        minSize: 175,\n        maxSize: 400,\n        titlebar: true,\n        collapsible: true,\n        panels: [new CP(\"autoTabs\", {title: \"Auto Tabs\", closable: true})]\n    },\n    south: {\n        split:true,\n        initialSize: 100,\n        minSize: 100,\n        maxSize: 200,\n        titlebar: true,\n        collapsible: true,\n        panels: [new CP(\"south\", {title: \"South\", closable: true})]\n    },\n    center: {\n        titlebar: true,\n        autoScroll:true,\n        resizeTabs: true,\n        minTabWidth: 50,\n        preferredTabWidth: 150,\n        panels: [\n            new CP(\"center1\", {title: \"Close Me\", closable: true}),\n            new CP(\"center2\", {title: \"Center Panel\", closable: false})\n        ]\n    }\n}, document.body);\n\nlayout.getRegion(\"center\").showPanel(\"center1\");\n
", "sig" : "(config, targetEl)", "static" : true, - "memberOf" : "Roo.BorderLayout" + "memberOf" : "Roo.BorderLayout", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "config", + "type" : "", + "desc" : "", + "isOptional" : false + }, + { + "name" : "targetEl", + "type" : "", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "endUpdate", @@ -11426,7 +37783,25 @@ "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout", "sig" : "(noLayout)", "static" : false, - "memberOf" : "Roo.LayoutManager" + "memberOf" : "Roo.LayoutManager", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "noLayout", + "type" : "Boolean", + "desc" : "true to disable a layout update", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "findPanel", @@ -11434,7 +37809,31 @@ "desc" : "Searches all regions for a panel with the specified id", "sig" : "(panelId)", "static" : false, - "memberOf" : "Roo.BorderLayout" + "memberOf" : "Roo.BorderLayout", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panelId", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel or null if it wasn't found" + } + ] }, { "name" : "fireEvent", @@ -11442,7 +37841,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getEl", @@ -11450,7 +37879,24 @@ "desc" : "Returns the Element this layout is bound to.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.LayoutManager" + "memberOf" : "Roo.LayoutManager", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] }, { "name" : "getRegion", @@ -11458,7 +37904,31 @@ "desc" : "Returns the specified region.", "sig" : "(target)", "static" : false, - "memberOf" : "Roo.LayoutManager" + "memberOf" : "Roo.LayoutManager", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "target", + "type" : "String", + "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.LayoutRegion", + "desc" : "" + } + ] }, { "name" : "getViewSize", @@ -11466,7 +37936,24 @@ "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.LayoutManager" + "memberOf" : "Roo.LayoutManager", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The size as an object {width: (the width), height: (the height)}" + } + ] }, { "name" : "hasListener", @@ -11474,7 +37961,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "isUpdating", @@ -11482,7 +37993,24 @@ "desc" : "Returns true if this layout is currently being updated", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.LayoutManager" + "memberOf" : "Roo.LayoutManager", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "layout", @@ -11490,7 +38018,18 @@ "desc" : "Performs a layout update.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BorderLayout" + "memberOf" : "Roo.BorderLayout", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -11498,7 +38037,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -11506,7 +38081,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -11514,7 +38100,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "remove", @@ -11522,7 +38126,37 @@ "desc" : "Remove a ContentPanel (or subclass) to this layout.", "sig" : "(target, panel)", "static" : false, - "memberOf" : "Roo.BorderLayout" + "memberOf" : "Roo.BorderLayout", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "target", + "type" : "String", + "desc" : "The target region key (north, south, east, west or center).", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Number/String/Roo.ContentPanel", + "desc" : "The index, id or panel to remove", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The removed panel" + } + ] }, { "name" : "removeListener", @@ -11530,7 +38164,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "restoreState", @@ -11538,7 +38202,25 @@ "desc" : "Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.", "sig" : "(provider)", "static" : false, - "memberOf" : "Roo.BorderLayout" + "memberOf" : "Roo.BorderLayout", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "provider", + "type" : "Roo.state.Provider", + "desc" : "(optional) An alternate state provider", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "showPanel", @@ -11546,7 +38228,31 @@ "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.", "sig" : "(panelId)", "static" : false, - "memberOf" : "Roo.BorderLayout" + "memberOf" : "Roo.BorderLayout", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panelId", + "type" : "String/ContentPanel", + "desc" : "The panels id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The shown panel or null" + } + ] }, { "name" : "un", @@ -11554,7 +38260,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -11735,21 +38471,114 @@ "type" : "function", "desc" : "Fired before resize is allowed. Set enabled to false to cancel resize.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Resizable", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The mousedown event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fired after a resize.", "sig" : "function (_self, width, height, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Resizable", + "desc" : "", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new width", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resizing", "type" : "function", "desc" : "Fired a resizing.", "sig" : "function (_self, x, y, w, h, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Resizable", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + }, + { + "name" : "w", + "type" : "Number", + "desc" : "The new w width", + "isOptional" : false + }, + { + "name" : "h", + "type" : "Number", + "desc" : "The new h hight", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The mouseup event", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -11759,7 +38588,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -11767,7 +38614,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -11775,7 +38658,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -11783,7 +38696,25 @@ "desc" : "Destroys this resizable. If the element was wrapped and\nremoveEl is not true then the element remains.", "sig" : "(removeEl)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "removeEl", + "type" : "Boolean", + "desc" : "(optional) true to remove the element from the DOM", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -11791,7 +38722,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getEl", @@ -11799,7 +38760,24 @@ "desc" : "Returns the element this component is bound to.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] }, { "name" : "getResizeChild", @@ -11807,7 +38785,24 @@ "desc" : "Returns the resizeChild element (or null).", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -11815,7 +38810,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "on", @@ -11823,7 +38842,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -11831,7 +38886,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -11839,7 +38905,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -11847,7 +38931,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "resizeTo", @@ -11855,7 +38969,31 @@ "desc" : "Perform a manual resize", "sig" : "(width, height)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "un", @@ -11863,7 +39001,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -11890,7 +39058,18 @@ "desc" : "Hides this shadow", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -11898,7 +39077,18 @@ "desc" : "Returns true if the shadow is visible, else false", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "realign", @@ -11906,7 +39096,43 @@ "desc" : "Direct alignment when values are already available. Show must be called at least once before\ncalling this method to ensure it is initialized.", "sig" : "(left, top, width, height)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The target element left position", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The target element top position", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The target element width", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The target element height", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setZIndex", @@ -11914,7 +39140,25 @@ "desc" : "Adjust the z-index of this shadow", "sig" : "(zindex)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "zindex", + "type" : "Number", + "desc" : "The new z-index", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", @@ -11922,7 +39166,25 @@ "desc" : "Displays the shadow under the target element", "sig" : "(targetEl)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "targetEl", + "type" : "String/HTMLElement/Element", + "desc" : "The id or element under which the shadow should display", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -11941,21 +39203,72 @@ "type" : "function", "desc" : "Fires before the splitter is dragged", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.SplitBar", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "moved", "type" : "function", "desc" : "Fires when the splitter is moved", "sig" : "function (_self, newSize)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.SplitBar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "the new width or height", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires when the splitter is moved (alias for {@link #event-moved})", "sig" : "function (_self, newSize)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.SplitBar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "the new width or height", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -11965,7 +39278,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -11973,7 +39304,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -11981,7 +39348,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -11989,7 +39386,25 @@ "desc" : "Destroy this splitbar.", "sig" : "(removeEl)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "removeEl", + "type" : "Boolean", + "desc" : "True to remove the element", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -11997,7 +39412,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getAdapter", @@ -12005,7 +39450,24 @@ "desc" : "Get the adapter this SplitBar uses", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "The adapter object" + } + ] }, { "name" : "getMaximumSize", @@ -12013,7 +39475,24 @@ "desc" : "Gets the maximum size for the resizing element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The maximum size" + } + ] }, { "name" : "getMinimumSize", @@ -12021,7 +39500,24 @@ "desc" : "Gets the minimum size for the resizing element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The minimum size" + } + ] }, { "name" : "hasListener", @@ -12029,7 +39525,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "on", @@ -12037,7 +39557,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -12045,7 +39601,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -12053,7 +39620,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -12061,7 +39646,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "setAdapter", @@ -12069,7 +39684,25 @@ "desc" : "Set the adapter this SplitBar uses", "sig" : "(adapter)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adapter", + "type" : "Object", + "desc" : "A SplitBar adapter object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setCurrentSize", @@ -12077,7 +39710,25 @@ "desc" : "Sets the initialize size for the resizing element", "sig" : "(size)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "size", + "type" : "Number", + "desc" : "The initial size", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setMaximumSize", @@ -12085,7 +39736,25 @@ "desc" : "Sets the maximum size for the resizing element", "sig" : "(maxSize)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "maxSize", + "type" : "Number", + "desc" : "The maximum size", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setMinimumSize", @@ -12093,7 +39762,25 @@ "desc" : "Sets the minimum size for the resizing element", "sig" : "(minSize)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "minSize", + "type" : "Number", + "desc" : "The minimum size", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "un", @@ -12101,7 +39788,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -12115,7 +39832,25 @@ "desc" : "Called before drag operations to get the current size of the resizing element.", "sig" : "(s)", "static" : false, - "memberOf" : "Roo.SplitBar.BasicLayoutAdapter" + "memberOf" : "Roo.SplitBar.BasicLayoutAdapter", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "s", + "type" : "Roo.SplitBar", + "desc" : "The SplitBar using this adapter", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setElementSize", @@ -12123,7 +39858,37 @@ "desc" : "Called after drag operations to set the size of the resizing element.", "sig" : "(s, newSize, onComplete)", "static" : false, - "memberOf" : "Roo.SplitBar.BasicLayoutAdapter" + "memberOf" : "Roo.SplitBar.BasicLayoutAdapter", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "s", + "type" : "Roo.SplitBar", + "desc" : "The SplitBar using this adapter", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new size to set", + "isOptional" : false + }, + { + "name" : "onComplete", + "type" : "Function", + "desc" : "A function to be invoked when resizing is complete", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -12137,7 +39902,25 @@ "desc" : "Called before drag operations to get the current size of the resizing element.", "sig" : "(s)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "s", + "type" : "Roo.SplitBar", + "desc" : "The SplitBar using this adapter", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setElementSize", @@ -12145,7 +39928,37 @@ "desc" : "Called after drag operations to set the size of the resizing element.", "sig" : "(s, newSize, onComplete)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "s", + "type" : "Roo.SplitBar", + "desc" : "The SplitBar using this adapter", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new size to set", + "isOptional" : false + }, + { + "name" : "onComplete", + "type" : "Function", + "desc" : "A function to be invoked when resizing is complete", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -12225,7 +40038,7 @@ }, { "name" : "menu", - "type" : "Mixed", + "type" : "Roo.menu.Menu", "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).", "memberOf" : "Roo.Button" }, @@ -12314,42 +40127,150 @@ "type" : "function", "desc" : "Fires when this button's arrow is clicked", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SplitButton", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "EventObject", + "desc" : "The click event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fires when this button is clicked", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "EventObject", + "desc" : "The click event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseout", "type" : "function", "desc" : "Fires when the mouse exits the button", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseover", "type" : "function", "desc" : "Fires when the mouse hovers over the button", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires when the button is rendered", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "toggle", "type" : "function", "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)", "sig" : "function (_self, pressed)\n{\n\n}", - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "pressed", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -12359,7 +40280,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -12367,7 +40306,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -12375,7 +40350,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -12383,7 +40388,18 @@ "desc" : "Destroys this Button and removes any listeners.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -12391,7 +40407,18 @@ "desc" : "Disable this button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "enable", @@ -12399,7 +40426,18 @@ "desc" : "Enable this button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -12407,7 +40445,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -12415,7 +40483,18 @@ "desc" : "Focus the button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "getEl", @@ -12423,7 +40502,24 @@ "desc" : "Returns the button's underlying element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] }, { "name" : "getText", @@ -12431,7 +40527,24 @@ "desc" : "Gets the text for this button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The button text" + } + ] }, { "name" : "hasListener", @@ -12439,7 +40552,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -12447,7 +40584,18 @@ "desc" : "Hide this button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -12455,7 +40603,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -12463,7 +40647,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -12471,7 +40666,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -12479,7 +40692,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "setArrowHandler", @@ -12487,7 +40730,31 @@ "desc" : "Sets this button's arrow click handler", "sig" : "(handler, scope)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "handler", + "type" : "Function", + "desc" : "The function to call when the arrow is clicked", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) Scope for the function passed above", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDisabled", @@ -12495,7 +40762,25 @@ "desc" : "Convenience function for boolean enable/disable", "sig" : "(enabled)", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "enabled", + "type" : "Boolean", + "desc" : "True to enable, false to disable", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setHandler", @@ -12503,7 +40788,31 @@ "desc" : "Sets this button's click handler", "sig" : "(handler, scope)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "handler", + "type" : "Function", + "desc" : "The function to call when the button is clicked", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) Scope for the function passed above", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setText", @@ -12511,7 +40820,25 @@ "desc" : "Sets this button's text", "sig" : "(text)", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The button text", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -12519,7 +40846,25 @@ "desc" : "Convenience function for boolean show/hide", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "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" : "show", @@ -12527,7 +40872,18 @@ "desc" : "Show this button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "toggle", @@ -12535,7 +40891,25 @@ "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.", "sig" : "(state)", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "state", + "type" : "Boolean", + "desc" : "(optional) Force a particular state", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "un", @@ -12543,7 +40917,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -12691,11 +41095,7 @@ "name" : "tabPosition", "type" : "String", "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [ - "top", - "bottom" - ] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "title", @@ -12728,84 +41128,282 @@ "type" : "function", "desc" : "Fires when this region before collapse.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeremove", "type" : "function", "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.", "sig" : "function (_self, panel, e)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The panel", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "The cancel event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "collapsed", "type" : "function", "desc" : "Fires when this region is collapsed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "expanded", "type" : "function", "desc" : "Fires when this region is expanded.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalidated", "type" : "function", "desc" : "Fires when the layout for this region is changed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "panelactivated", "type" : "function", "desc" : "Fires when a panel is activated.", "sig" : "function (_self, panel)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The activated panel", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "paneladded", "type" : "function", "desc" : "Fires when a panel is added.", "sig" : "function (_self, panel)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The panel", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "panelremoved", "type" : "function", "desc" : "Fires when a panel is removed.", "sig" : "function (_self, panel)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The panel", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resized", "type" : "function", "desc" : "Fires when the user resizes this region.", "sig" : "function (_self, newSize)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new size (width for east/west, height for north/south)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "slidehide", "type" : "function", "desc" : "Fires when this region slides out of view.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "slideshow", "type" : "function", "desc" : "Fires when this region is slid into view.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "visibilitychange", "type" : "function", "desc" : "Fires when this region is shown or hidden", "sig" : "function (_self, visibility)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "visibility", + "type" : "Boolean", + "desc" : "true or false", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -12815,7 +41413,31 @@ "desc" : "Adds the passed ContentPanel(s) to this region.", "sig" : "(panel)", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panel", + "type" : "ContentPanel...", + "desc" : "The ContentPanel(s) to add (you can pass more than one)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel added (if only one was added; null otherwise)" + } + ] }, { "name" : "addEvents", @@ -12823,7 +41445,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -12831,7 +41471,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -12839,7 +41515,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "collapse", @@ -12847,7 +41553,25 @@ "desc" : "Collapses this region.", "sig" : "(skipAnim)", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "skipAnim", + "type" : "Boolean", + "desc" : "(optional) true to collapse the element without animation (if animate is true)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "expand", @@ -12855,7 +41579,31 @@ "desc" : "Expands this region if it was previously collapsed.", "sig" : "(e, skipAnim)", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event that triggered the expand (or null if calling manually)", + "isOptional" : false + }, + { + "name" : "skipAnim", + "type" : "Boolean", + "desc" : "(optional) true to expand the element without animation (if animate is true)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -12863,7 +41611,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getActivePanel", @@ -12871,7 +41649,24 @@ "desc" : "Get the active panel for this region.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The active panel or null" + } + ] }, { "name" : "getEl", @@ -12879,7 +41674,24 @@ "desc" : "Returns the container element for this region.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] }, { "name" : "getPanel", @@ -12887,7 +41699,31 @@ "desc" : "Returns the panel specified or null if it's not in this region.", "sig" : "(panel)", "static" : false, - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "" + } + ] }, { "name" : "getPosition", @@ -12895,7 +41731,24 @@ "desc" : "Returns this regions position (north/south/east/west/center).", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getSplitBar", @@ -12903,7 +41756,24 @@ "desc" : "Returns the {@link Roo.SplitBar} for this region.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.SplitBar", + "desc" : "" + } + ] }, { "name" : "getTabs", @@ -12911,7 +41781,24 @@ "desc" : "Returns the TabPanel component used by this region", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanel", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -12919,7 +41806,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hasPanel", @@ -12927,7 +41838,31 @@ "desc" : "Returns true if the panel is in this region.", "sig" : "(panel)", "static" : false, - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "hide", @@ -12935,7 +41870,18 @@ "desc" : "Hides this region.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hidePanel", @@ -12943,7 +41889,25 @@ "desc" : "Hides the tab for the specified panel.", "sig" : "(panel)", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "isVisible", @@ -12951,7 +41915,24 @@ "desc" : "Returns true if this region is currently visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "on", @@ -12959,7 +41940,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -12967,7 +41984,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -12975,7 +42003,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "remove", @@ -12983,7 +42029,37 @@ "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.", "sig" : "(panel, preservePanel)", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + }, + { + "name" : "preservePanel", + "type" : "Boolean", + "desc" : "Overrides the config preservePanel option", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel that was removed" + } + ] }, { "name" : "removeListener", @@ -12991,7 +42067,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "resizeTo", @@ -12999,7 +42105,25 @@ "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.", "sig" : "(newSize)", "static" : false, - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new width or height", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setCollapsedTitle", @@ -13007,7 +42131,25 @@ "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)", "sig" : "(title)", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \" \")", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", @@ -13015,7 +42157,18 @@ "desc" : "Shows this region if it was previously hidden.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "showPanel", @@ -13023,7 +42176,31 @@ "desc" : "Shows the specified panel.", "sig" : "(panelId)", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panelId", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The shown panel, or null if a panel could not be found from panelId" + } + ] }, { "name" : "un", @@ -13031,7 +42208,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "unhidePanel", @@ -13039,7 +42246,25 @@ "desc" : "Unhides the tab for a previously hidden panel.", "sig" : "(panel)", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -13058,14 +42283,58 @@ "type" : "function", "desc" : "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change", "sig" : "function (_self, e, tab)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.TabPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "Set cancel to true on this object to cancel the tab change", + "isOptional" : false + }, + { + "name" : "tab", + "type" : "Roo.TabPanelItem", + "desc" : "The tab being changed to", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "tabchange", "type" : "function", "desc" : "Fires when the active tab changes", "sig" : "function (_self, activePanel)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.TabPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "activePanel", + "type" : "Roo.TabPanelItem", + "desc" : "The new active tab", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -13075,7 +42344,31 @@ "desc" : "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated.", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to activate.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanelItem", + "desc" : "The TabPanelItem." + } + ] }, { "name" : "addEvents", @@ -13083,7 +42376,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -13091,7 +42402,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "addTab", @@ -13099,7 +42446,49 @@ "desc" : "Creates a new {@link Roo.TabPanelItem} by looking for an existing element with the provided id -- if it's not found it creates one.", "sig" : "(id, text, content, closable)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id of the div to use or create", + "isOptional" : false + }, + { + "name" : "text", + "type" : "String", + "desc" : "The text for the tab", + "isOptional" : false + }, + { + "name" : "content", + "type" : "String", + "desc" : "(optional) Content to put in the TabPanelItem body", + "isOptional" : false + }, + { + "name" : "closable", + "type" : "Boolean", + "desc" : "(optional) True to create a close icon on the tab", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanelItem", + "desc" : "The created TabPanelItem" + } + ] }, { "name" : "addTabItem", @@ -13107,7 +42496,25 @@ "desc" : "Adds an existing {@link Roo.TabPanelItem}.", "sig" : "(item)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "item", + "type" : "Roo.TabPanelItem", + "desc" : "The TabPanelItem to add", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "autoSizeTabs", @@ -13115,7 +42522,18 @@ "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "beginUpdate", @@ -13123,7 +42541,18 @@ "desc" : "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -13131,7 +42560,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -13139,7 +42598,25 @@ "desc" : "Destroys this TabPanel", "sig" : "(removeEl)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "removeEl", + "type" : "Boolean", + "desc" : "(optional) True to remove the element from the DOM as well (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "disableTab", @@ -13147,7 +42624,25 @@ "desc" : "Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored.", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to disable.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enableTab", @@ -13155,7 +42650,25 @@ "desc" : "Enables a {@link Roo.TabPanelItem} that is disabled.", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to enable.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "endUpdate", @@ -13163,7 +42676,18 @@ "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -13171,7 +42695,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getActiveTab", @@ -13179,7 +42733,24 @@ "desc" : "Gets the active {@link Roo.TabPanelItem}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanelItem", + "desc" : "The active TabPanelItem or null if none are active." + } + ] }, { "name" : "getCount", @@ -13187,7 +42758,24 @@ "desc" : "Returns the number of tabs in this TabPanel.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] }, { "name" : "getTab", @@ -13195,7 +42783,31 @@ "desc" : "Returns the {@link Roo.TabPanelItem} with the specified id/index", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to fetch.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanelItem", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -13203,7 +42815,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hideTab", @@ -13211,7 +42847,25 @@ "desc" : "Hides the {@link Roo.TabPanelItem} with the specified id/index", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to hide.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -13219,7 +42873,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -13227,7 +42917,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -13235,7 +42936,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -13243,7 +42962,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "removeTab", @@ -13251,7 +43000,25 @@ "desc" : "Removes a {@link Roo.TabPanelItem}.", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to remove.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setTabWidth", @@ -13259,7 +43026,25 @@ "desc" : "Resizes all the tabs to the passed width", "sig" : "(The)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "The", + "type" : "Number", + "desc" : "new width", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "syncHeight", @@ -13267,7 +43052,25 @@ "desc" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling", "sig" : "(targetHeight)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "targetHeight", + "type" : "Number", + "desc" : "(optional) Override the starting height from the elements height", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "un", @@ -13275,7 +43078,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "unhideTab", @@ -13283,7 +43116,25 @@ "desc" : "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index.", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to unhide.", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -13302,28 +43153,98 @@ "type" : "function", "desc" : "Fires when this tab becomes the active tab.", "sig" : "function (tabPanel, _self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tabPanel", + "type" : "Roo.TabPanel", + "desc" : "The parent TabPanel", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Roo.TabPanelItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeclose", "type" : "function", "desc" : "Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true).", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.TabPanelItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "Set cancel to true on this object to cancel the close.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "close", "type" : "function", "desc" : "Fires when this tab is closed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.TabPanelItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "deactivate", "type" : "function", "desc" : "Fires when this tab is no longer the active tab.", "sig" : "function (tabPanel, _self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tabPanel", + "type" : "Roo.TabPanel", + "desc" : "The parent TabPanel", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Roo.TabPanelItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -13333,7 +43254,18 @@ "desc" : "Activates this TabPanelItem -- this does deactivate the currently active TabPanelItem.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "addEvents", @@ -13341,7 +43273,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -13349,7 +43299,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -13357,7 +43343,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "disable", @@ -13365,7 +43381,18 @@ "desc" : "Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "enable", @@ -13373,7 +43400,18 @@ "desc" : "Enables this TabPanelItem if it was previously disabled.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -13381,7 +43419,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getText", @@ -13389,7 +43457,24 @@ "desc" : "Returns the text for this tab", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getUpdateManager", @@ -13397,7 +43482,24 @@ "desc" : "Gets the {@link Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] }, { "name" : "hasListener", @@ -13405,7 +43507,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -13413,7 +43539,18 @@ "desc" : "Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isActive", @@ -13421,7 +43558,24 @@ "desc" : "Returns true if this tab is the active tab.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isHidden", @@ -13429,7 +43583,24 @@ "desc" : "Returns true if this tab is \"hidden\"", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "on", @@ -13437,7 +43608,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -13445,7 +43652,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "refresh", @@ -13453,7 +43671,18 @@ "desc" : "Forces a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the setUrl method has not been called.\n This does not activate the panel, just updates its content.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -13461,7 +43690,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -13469,7 +43716,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "setContent", @@ -13477,7 +43754,31 @@ "desc" : "Sets the content for this TabPanelItem.", "sig" : "(content, loadScripts)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "content", + "type" : "String", + "desc" : "The content", + "isOptional" : false + }, + { + "name" : "loadScripts", + "type" : "Boolean", + "desc" : "true to look for and load scripts", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setHidden", @@ -13485,7 +43786,25 @@ "desc" : "Show or hide the tab", "sig" : "(hidden)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to hide or false to show.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setText", @@ -13493,7 +43812,25 @@ "desc" : "Sets the text for the tab (Note: this also sets the tooltip text)", "sig" : "(text)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The tab's text and tooltip", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setTooltip", @@ -13501,7 +43838,25 @@ "desc" : "Set the tooltip for the tab.", "sig" : "(tooltip)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "tooltip", + "type" : "String", + "desc" : "The tab's tooltip", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setUrl", @@ -13509,7 +43864,43 @@ "desc" : "Set a URL to be used to load the content for this TabPanelItem.", "sig" : "(url, params, loadOnce)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "url", + "type" : "String/Function", + "desc" : "The URL to load the content from, or a function to call to get the URL", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)", + "isOptional" : false + }, + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this TabPanelItem is activated. (Defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] }, { "name" : "show", @@ -13517,7 +43908,18 @@ "desc" : "Shows this TabPanelItem -- this does not deactivate the currently active TabPanelItem.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -13525,7 +43927,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -13558,7 +43990,43 @@ "desc" : "Applies the supplied values to the template and appends the new node(s) to el.", "sig" : "(el, values, returnElement)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] }, { "name" : "apply", @@ -13566,7 +44034,18 @@ "desc" : "Alias for {@link #applyTemplate}", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "applyTemplate", @@ -13574,7 +44053,31 @@ "desc" : "Returns an HTML fragment of this template with the specified values applied.", "sig" : "(values)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The HTML fragment" + } + ] }, { "name" : "compile", @@ -13582,7 +44085,24 @@ "desc" : "Compiles the template into an internal function, eliminating the RegEx overhead.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Template", + "desc" : "this" + } + ] }, { "name" : "from", @@ -13590,7 +44110,25 @@ "desc" : "Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML.", "sig" : "(el)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement", + "desc" : "A DOM element or its id", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "insertAfter", @@ -13598,7 +44136,43 @@ "desc" : "Applies the supplied values to the template and inserts the new node(s) after el.", "sig" : "(el, values, returnElement)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] }, { "name" : "insertBefore", @@ -13606,7 +44180,43 @@ "desc" : "Applies the supplied values to the template and inserts the new node(s) before el.", "sig" : "(el, values, returnElement)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] }, { "name" : "insertFirst", @@ -13614,7 +44224,43 @@ "desc" : "Applies the supplied values to the template and inserts the new node(s) as the first child of el.", "sig" : "(el, values, returnElement)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] }, { "name" : "overwrite", @@ -13622,7 +44268,43 @@ "desc" : "Applies the supplied values to the template and overwrites the content of el with the new node(s).", "sig" : "(el, values, returnElement)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] }, { "name" : "set", @@ -13630,7 +44312,37 @@ "desc" : "Sets the HTML used as the template and optionally compiles it.", "sig" : "(html, compile)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "compile", + "type" : "Boolean", + "desc" : "(optional) True to compile the template (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Template", + "desc" : "this" + } + ] } ] }, @@ -13663,7 +44375,31 @@ "desc" : "Adds element(s) to the toolbar -- this function takes a variable number of \narguments of mixed type and adds them to the toolbar.", "sig" : "(arg1, arg2)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "arg1", + "type" : "Mixed", + "desc" : "The following types of arguments are all valid:
\n", + "isOptional" : false + }, + { + "name" : "arg2", + "type" : "Mixed", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addButton", @@ -13671,7 +44407,31 @@ "desc" : "Adds a button (or buttons). See {@link Roo.Toolbar.Button} for more info on the config.", "sig" : "(config)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "config", + "type" : "Object/Array", + "desc" : "A button config or array of configs", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Button/Array", + "desc" : "" + } + ] }, { "name" : "addDom", @@ -13679,7 +44439,31 @@ "desc" : "Adds a new element to the toolbar from the passed {@link Roo.DomHelper} config.", "sig" : "(config)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Item", + "desc" : "The element's item" + } + ] }, { "name" : "addElement", @@ -13687,7 +44471,31 @@ "desc" : "Adds any standard HTML element to the toolbar", "sig" : "(el)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The element or id of the element to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Item", + "desc" : "The element's item" + } + ] }, { "name" : "addField", @@ -13695,7 +44503,31 @@ "desc" : "Adds a dynamically rendered Roo.form field (TextField, ComboBox, etc).\nNote: the field should not have been rendered yet. For a field that has already been\nrendered, use {@link #addElement}.", "sig" : "(field)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "field", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ToolbarItem", + "desc" : "" + } + ] }, { "name" : "addFill", @@ -13703,7 +44535,24 @@ "desc" : "Adds a fill element that forces subsequent additions to the right side of the toolbar", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Fill", + "desc" : "The fill item" + } + ] }, { "name" : "addItem", @@ -13711,7 +44560,31 @@ "desc" : "Adds any Toolbar.Item or subclass", "sig" : "(item)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "item", + "type" : "Roo.Toolbar.Item", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Item", + "desc" : "The item" + } + ] }, { "name" : "addSeparator", @@ -13719,7 +44592,24 @@ "desc" : "Adds a separator", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Item", + "desc" : "The separator item" + } + ] }, { "name" : "addSpacer", @@ -13727,7 +44617,24 @@ "desc" : "Adds a spacer element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Spacer", + "desc" : "The spacer item" + } + ] }, { "name" : "addText", @@ -13735,7 +44642,31 @@ "desc" : "Adds text to the toolbar", "sig" : "(text)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The text to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Item", + "desc" : "The element's item" + } + ] }, { "name" : "addxtype", @@ -13743,7 +44674,31 @@ "desc" : "Add an Xtype element", "sig" : "(xtype)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "xtype", + "type" : "Object", + "desc" : "Xtype Object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "created Object" + } + ] }, { "name" : "getEl", @@ -13751,7 +44706,24 @@ "desc" : "Returns the Element for this toolbar.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] }, { "name" : "hide", @@ -13759,7 +44731,18 @@ "desc" : "Hide the toolbar", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "insertButton", @@ -13767,7 +44750,37 @@ "desc" : "Inserts any {@link Roo.Toolbar.Item}/{@link Roo.Toolbar.Button} at the specified index.", "sig" : "(index, item)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index where the item is to be inserted", + "isOptional" : false + }, + { + "name" : "item", + "type" : "Object/Roo.Toolbar.Item/Roo.Toolbar.Button (may be Array)", + "desc" : "The button, or button config object to be inserted.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar.Button/Item", + "desc" : "" + } + ] }, { "name" : "show", @@ -13775,7 +44788,18 @@ "desc" : "Show the toolbar", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -13843,7 +44867,7 @@ }, { "name" : "menu", - "type" : "Mixed", + "type" : "Roo.menu.Menu", "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).", "memberOf" : "Roo.Button" }, @@ -13932,35 +44956,124 @@ "type" : "function", "desc" : "Fires when this button is clicked", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "EventObject", + "desc" : "The click event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseout", "type" : "function", "desc" : "Fires when the mouse exits the button", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseover", "type" : "function", "desc" : "Fires when the mouse hovers over the button", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires when the button is rendered", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "toggle", "type" : "function", "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)", "sig" : "function (_self, pressed)\n{\n\n}", - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "pressed", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -13970,7 +45083,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -13978,7 +45109,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -13986,7 +45153,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -13994,7 +45191,18 @@ "desc" : "Removes and destroys this button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -14002,7 +45210,18 @@ "desc" : "Disables this item", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "enable", @@ -14010,7 +45229,18 @@ "desc" : "Enables this item", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -14018,7 +45248,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -14026,7 +45286,18 @@ "desc" : "Focus the button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "getEl", @@ -14034,7 +45305,24 @@ "desc" : "Returns the button's underlying element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] }, { "name" : "getText", @@ -14042,7 +45330,24 @@ "desc" : "Gets the text for this button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The button text" + } + ] }, { "name" : "hasListener", @@ -14050,7 +45355,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -14058,7 +45387,18 @@ "desc" : "Hides this button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -14066,7 +45406,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -14074,7 +45450,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -14082,7 +45469,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -14090,7 +45495,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "setDisabled", @@ -14098,7 +45533,25 @@ "desc" : "Convenience function for boolean enable/disable", "sig" : "(enabled)", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "enabled", + "type" : "Boolean", + "desc" : "True to enable, false to disable", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setHandler", @@ -14106,7 +45559,31 @@ "desc" : "Assigns this button's click handler", "sig" : "(handler, scope)", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "handler", + "type" : "Function", + "desc" : "The function to call when the button is clicked", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) Scope for the function passed in", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setText", @@ -14114,7 +45591,25 @@ "desc" : "Sets this button's text", "sig" : "(text)", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The button text", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -14122,7 +45617,25 @@ "desc" : "Convenience function for boolean show/hide", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "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" : "show", @@ -14130,7 +45643,18 @@ "desc" : "Shows this button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "toggle", @@ -14138,7 +45662,25 @@ "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.", "sig" : "(state)", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "state", + "type" : "Boolean", + "desc" : "(optional) Force a particular state", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "un", @@ -14146,7 +45688,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -14158,7 +45730,20 @@ "type" : "function", "desc" : "Fires when the button is rendered", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -14168,7 +45753,18 @@ "desc" : "Removes and destroys this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -14176,7 +45772,18 @@ "desc" : "Disables this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "enable", @@ -14184,7 +45791,18 @@ "desc" : "Enables this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "focus", @@ -14192,7 +45810,18 @@ "desc" : "Try to focus this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "getEl", @@ -14200,7 +45829,24 @@ "desc" : "Get this item's HTML Element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "" + } + ] }, { "name" : "hide", @@ -14208,7 +45854,18 @@ "desc" : "Hides this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -14216,7 +45873,25 @@ "desc" : "Convenience function for boolean show/hide.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "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" : "show", @@ -14224,7 +45899,18 @@ "desc" : "Shows this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -14236,7 +45922,20 @@ "type" : "function", "desc" : "Fires when the button is rendered", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -14246,7 +45945,18 @@ "desc" : "Removes and destroys this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -14254,7 +45964,18 @@ "desc" : "Disables this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "enable", @@ -14262,7 +45983,18 @@ "desc" : "Enables this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "focus", @@ -14270,7 +46002,18 @@ "desc" : "Try to focus this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "getEl", @@ -14278,7 +46021,24 @@ "desc" : "Get this item's HTML Element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "" + } + ] }, { "name" : "hide", @@ -14286,7 +46046,18 @@ "desc" : "Hides this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -14294,7 +46065,25 @@ "desc" : "Convenience function for boolean show/hide.", "sig" : "(visible)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "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" : "show", @@ -14302,7 +46091,18 @@ "desc" : "Shows this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -14314,7 +46114,20 @@ "type" : "function", "desc" : "Fires when the button is rendered", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -14324,7 +46137,18 @@ "desc" : "Removes and destroys this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -14332,7 +46156,18 @@ "desc" : "Disables this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "enable", @@ -14340,7 +46175,18 @@ "desc" : "Enables this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "focus", @@ -14348,7 +46194,18 @@ "desc" : "Try to focus this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "getEl", @@ -14356,7 +46213,24 @@ "desc" : "Get this item's HTML Element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "" + } + ] }, { "name" : "hide", @@ -14364,7 +46238,18 @@ "desc" : "Hides this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -14372,7 +46257,25 @@ "desc" : "Convenience function for boolean show/hide.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "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" : "show", @@ -14380,7 +46283,18 @@ "desc" : "Shows this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -14392,7 +46306,20 @@ "type" : "function", "desc" : "Fires when the button is rendered", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -14402,7 +46329,18 @@ "desc" : "Removes and destroys this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -14410,7 +46348,18 @@ "desc" : "Disables this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "enable", @@ -14418,7 +46367,18 @@ "desc" : "Enables this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "focus", @@ -14426,7 +46386,18 @@ "desc" : "Try to focus this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "getEl", @@ -14434,7 +46405,24 @@ "desc" : "Get this item's HTML Element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "" + } + ] }, { "name" : "hide", @@ -14442,7 +46430,18 @@ "desc" : "Hides this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -14450,7 +46449,25 @@ "desc" : "Convenience function for boolean show/hide.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "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" : "show", @@ -14458,7 +46475,18 @@ "desc" : "Shows this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -14538,7 +46566,7 @@ }, { "name" : "menu", - "type" : "Mixed", + "type" : "Roo.menu.Menu", "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).", "memberOf" : "Roo.Button" }, @@ -14627,42 +46655,150 @@ "type" : "function", "desc" : "Fires when this button's arrow is clicked", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.SplitButton" + "memberOf" : "Roo.SplitButton", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SplitButton", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "EventObject", + "desc" : "The click event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fires when this button is clicked", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "EventObject", + "desc" : "The click event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseout", "type" : "function", "desc" : "Fires when the mouse exits the button", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseover", "type" : "function", "desc" : "Fires when the mouse hovers over the button", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires when the button is rendered", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "toggle", "type" : "function", "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)", "sig" : "function (_self, pressed)\n{\n\n}", - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "pressed", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -14672,7 +46808,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -14680,7 +46834,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -14688,7 +46878,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -14696,7 +46916,18 @@ "desc" : "Removes and destroys this button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -14704,7 +46935,18 @@ "desc" : "Disable this button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "enable", @@ -14712,7 +46954,18 @@ "desc" : "Enable this button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -14720,7 +46973,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -14728,7 +47011,18 @@ "desc" : "Focus the button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.SplitButton" + "memberOf" : "Roo.SplitButton", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "getEl", @@ -14736,7 +47030,24 @@ "desc" : "Returns the button's underlying element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] }, { "name" : "getText", @@ -14744,7 +47055,24 @@ "desc" : "Gets the text for this button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The button text" + } + ] }, { "name" : "hasListener", @@ -14752,7 +47080,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -14760,7 +47112,18 @@ "desc" : "Hides this button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -14768,7 +47131,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -14776,7 +47175,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -14784,7 +47194,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -14792,7 +47220,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "setArrowHandler", @@ -14800,7 +47258,31 @@ "desc" : "Sets this button's arrow click handler", "sig" : "(handler, scope)", "static" : false, - "memberOf" : "Roo.SplitButton" + "memberOf" : "Roo.SplitButton", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "handler", + "type" : "Function", + "desc" : "The function to call when the arrow is clicked", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) Scope for the function passed above", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDisabled", @@ -14808,7 +47290,25 @@ "desc" : "Convenience function for boolean enable/disable", "sig" : "(enabled)", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "enabled", + "type" : "Boolean", + "desc" : "True to enable, false to disable", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setHandler", @@ -14816,7 +47316,31 @@ "desc" : "Sets this button's click handler", "sig" : "(handler, scope)", "static" : false, - "memberOf" : "Roo.SplitButton" + "memberOf" : "Roo.SplitButton", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "handler", + "type" : "Function", + "desc" : "The function to call when the button is clicked", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) Scope for the function passed above", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setText", @@ -14824,7 +47348,25 @@ "desc" : "Sets this button's text", "sig" : "(text)", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The button text", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -14832,7 +47374,25 @@ "desc" : "Convenience function for boolean show/hide", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "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" : "show", @@ -14840,7 +47400,18 @@ "desc" : "Shows this button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "toggle", @@ -14848,7 +47419,25 @@ "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.", "sig" : "(state)", "static" : false, - "memberOf" : "Roo.Button" + "memberOf" : "Roo.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "state", + "type" : "Boolean", + "desc" : "(optional) Force a particular state", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "un", @@ -14856,7 +47445,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -14875,7 +47494,20 @@ "type" : "function", "desc" : "Fires when the button is rendered", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Button", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -14885,7 +47517,18 @@ "desc" : "Removes and destroys this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -14893,7 +47536,18 @@ "desc" : "Disables this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "enable", @@ -14901,7 +47555,18 @@ "desc" : "Enables this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "focus", @@ -14909,7 +47574,18 @@ "desc" : "Try to focus this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "getEl", @@ -14917,7 +47593,24 @@ "desc" : "Get this item's HTML Element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "" + } + ] }, { "name" : "hide", @@ -14925,7 +47618,18 @@ "desc" : "Hides this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -14933,7 +47637,25 @@ "desc" : "Convenience function for boolean show/hide.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "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" : "show", @@ -14941,7 +47663,18 @@ "desc" : "Shows this item.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Toolbar.Item" + "memberOf" : "Roo.Toolbar.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -14955,7 +47688,7 @@ }, { "name" : "autoCreate", - "type" : "Boolean/Object", + "type" : "Boolean|Object", "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create", "memberOf" : "Roo.ContentPanel" }, @@ -15007,28 +47740,27 @@ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", "memberOf" : "Roo.ContentPanel" }, + { + "name" : "menu", + "type" : "Roo.menu.Menu", + "desc" : "popup menu", + "memberOf" : "Roo.ContentPanel" + }, { "name" : "params", - "type" : "String/Object", + "type" : "String|Object", "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", "memberOf" : "Roo.ContentPanel" }, { "name" : "region", "type" : "String", - "desc" : "t) which region to put this panel on (when used with xtype constructors)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [ - "center", - "north", - "south", - "east", - "west" - ] + "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)", + "memberOf" : "Roo.ContentPanel" }, { "name" : "resizeEl", - "type" : "String/HTMLElement/Element", + "type" : "String|HTMLElement|Element", "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)", "memberOf" : "Roo.ContentPanel" }, @@ -15046,7 +47778,7 @@ }, { "name" : "toolbar", - "type" : "Toolbar", + "type" : "Roo.Toolbar", "desc" : "A toolbar for this panel", "memberOf" : "Roo.ContentPanel" }, @@ -15063,28 +47795,92 @@ "type" : "function", "desc" : "Fires when this panel is activated.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.ContentPanel" + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "deactivate", "type" : "function", "desc" : "Fires when this panel is activated.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.ContentPanel" + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires when this tab is created", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.ContentPanel" + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires when this panel is resized if fitToFrame is true.", "sig" : "function (_self, width, height)\n{\n\n}", - "memberOf" : "Roo.ContentPanel" + "memberOf" : "Roo.ContentPanel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The width after any component adjustments", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The height after any component adjustments", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -15094,7 +47890,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -15102,7 +47916,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "addxtype", @@ -15110,7 +47960,25 @@ "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n
\n\nlayout.addxtype({\n       xtype : 'Form',\n       items: [ .... ]\n   }\n);\n\n
", "sig" : "(cfg)", "static" : false, - "memberOf" : "Roo.ContentPanel" + "memberOf" : "Roo.ContentPanel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cfg", + "type" : "Object", + "desc" : "Xtype definition of item to add.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "capture", @@ -15118,7 +47986,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -15126,7 +48024,18 @@ "desc" : "Destroys this panel", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.ContentPanel" + "memberOf" : "Roo.ContentPanel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -15134,7 +48043,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getEl", @@ -15142,7 +48081,24 @@ "desc" : "Returns this panel's element - used by regiosn to add.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.ContentPanel" + "memberOf" : "Roo.ContentPanel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] }, { "name" : "getId", @@ -15150,7 +48106,24 @@ "desc" : "Returns this panel's id", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.ContentPanel" + "memberOf" : "Roo.ContentPanel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getTitle", @@ -15158,7 +48131,24 @@ "desc" : "Returns this panel's title", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.ContentPanel" + "memberOf" : "Roo.ContentPanel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getToolbar", @@ -15166,7 +48156,24 @@ "desc" : "Returns the toolbar for this Panel if one was configured.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.ContentPanel" + "memberOf" : "Roo.ContentPanel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar", + "desc" : "" + } + ] }, { "name" : "getUpdateManager", @@ -15174,7 +48181,24 @@ "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.ContentPanel" + "memberOf" : "Roo.ContentPanel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] }, { "name" : "hasListener", @@ -15182,7 +48206,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "isClosable", @@ -15190,7 +48238,24 @@ "desc" : "Returns true is this panel was configured to be closable", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.ContentPanel" + "memberOf" : "Roo.ContentPanel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "load", @@ -15198,7 +48263,49 @@ "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.", "sig" : "(url, params, callback, discardUrl)", "static" : false, - "memberOf" : "Roo.ContentPanel" + "memberOf" : "Roo.ContentPanel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "url", + "type" : "Object/String/Function", + "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n
\npanel.load({\n    url: \"your-url.php\",\n    params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n    callback: yourFunction,\n    scope: yourObject, //(optional scope)\n    discardUrl: false,\n    nocache: false,\n    text: \"Loading...\",\n    timeout: 30,\n    scripts: false\n});\n
\nThe only required property is url. The optional properties nocache, text and scripts\nare shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this panel UpdateManager instance.", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)", + "isOptional" : false + }, + { + "name" : "discardUrl", + "type" : "Boolean", + "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "this" + } + ] }, { "name" : "on", @@ -15206,7 +48313,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -15214,7 +48357,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "refresh", @@ -15222,7 +48376,18 @@ "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.ContentPanel" + "memberOf" : "Roo.ContentPanel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -15230,7 +48395,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -15238,7 +48421,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "setContent", @@ -15246,7 +48459,31 @@ "desc" : "Updates this panel's element", "sig" : "(content, loadScripts)", "static" : false, - "memberOf" : "Roo.ContentPanel" + "memberOf" : "Roo.ContentPanel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "content", + "type" : "String", + "desc" : "The new content", + "isOptional" : false + }, + { + "name" : "loadScripts", + "type" : "Boolean", + "desc" : "(optional) true to look for and process scripts", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setTitle", @@ -15254,7 +48491,25 @@ "desc" : "Set this panel's title", "sig" : "(title)", "static" : false, - "memberOf" : "Roo.ContentPanel" + "memberOf" : "Roo.ContentPanel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setUrl", @@ -15262,7 +48517,43 @@ "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.", "sig" : "(url, params, loadOnce)", "static" : false, - "memberOf" : "Roo.ContentPanel" + "memberOf" : "Roo.ContentPanel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "url", + "type" : "String/Function", + "desc" : "The URL to load the content from or a function to call to get the URL", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)", + "isOptional" : false + }, + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] }, { "name" : "un", @@ -15270,7 +48561,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -15289,21 +48610,84 @@ "type" : "function", "desc" : "Fired before an update is made, return false from your handler and the update is cancelled.", "sig" : "function (el, url, params)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "Roo.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "url", + "type" : "String/Object/Function", + "desc" : "", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "failure", "type" : "function", "desc" : "Fired on update failure.", "sig" : "function (el, oResponseObject)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "Roo.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "oResponseObject", + "type" : "Object", + "desc" : "The response Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "update", "type" : "function", "desc" : "Fired after successful update is made.", "sig" : "function (el, oResponseObject)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "el", + "type" : "Roo.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "oResponseObject", + "type" : "Object", + "desc" : "The response Object", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -15313,7 +48697,18 @@ "desc" : "Aborts the executing transaction", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "addEvents", @@ -15321,7 +48716,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -15329,7 +48742,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -15337,7 +48786,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "fireEvent", @@ -15345,7 +48824,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "formUpdate", @@ -15353,7 +48862,43 @@ "desc" : "Performs an async form post, updating this element with the response. If the form has the attribute enctype=\"multipart/form-data\", it assumes it's a file upload.\nUses this.sslBlankUrl for SSL file uploads to prevent IE security warning.", "sig" : "(form, url, reset, callback)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "form", + "type" : "String/HTMLElement", + "desc" : "The form Id or form element", + "isOptional" : false + }, + { + "name" : "url", + "type" : "String", + "desc" : "(optional) The url to pass the form to. If omitted the action attribute on the form will be used.", + "isOptional" : false + }, + { + "name" : "reset", + "type" : "Boolean", + "desc" : "(optional) Whether to try to reset the form after the update", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -15361,7 +48906,24 @@ "desc" : "Get the Element this UpdateManager is bound to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] }, { "name" : "hasListener", @@ -15369,7 +48931,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "isUpdating", @@ -15377,7 +48963,24 @@ "desc" : "Returns true if an update is in progress", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "on", @@ -15385,7 +48988,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -15393,7 +49032,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "refresh", @@ -15401,7 +49051,25 @@ "desc" : "Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately", "sig" : "(callback)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "releaseCapture", @@ -15409,7 +49077,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -15417,7 +49103,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "setDefaultUrl", @@ -15425,7 +49141,25 @@ "desc" : "Set the defaultUrl used for updates", "sig" : "(defaultUrl)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "defaultUrl", + "type" : "String/Function", + "desc" : "The url or a function to call to get the url", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRenderer", @@ -15433,7 +49167,25 @@ "desc" : "Set the content renderer for this UpdateManager. See {@link Roo.UpdateManager.BasicRenderer#render} for more details.", "sig" : "(renderer)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "renderer", + "type" : "Object", + "desc" : "The object implementing the render() method", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "showLoading", @@ -15441,7 +49193,18 @@ "desc" : "Called to update the element to \"Loading\" state. Override to perform custom action.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "startAutoRefresh", @@ -15449,7 +49212,49 @@ "desc" : "Set this element to auto refresh.", "sig" : "(interval, url, params, callback, refreshNow)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "interval", + "type" : "Number", + "desc" : "How often to update (in seconds).", + "isOptional" : false + }, + { + "name" : "url", + "type" : "String/Function", + "desc" : "(optional) The url for this request or a function to call to get the url (Defaults to the last used url)", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The parameters to pass as either a url encoded string \"¶m1=1¶m2=2\" or as an object {param1: 1, param2: 2}", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)", + "isOptional" : false + }, + { + "name" : "refreshNow", + "type" : "Boolean", + "desc" : "(optional) Whether to execute the refresh now, or wait the interval", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "stopAutoRefresh", @@ -15457,7 +49262,18 @@ "desc" : "Stop auto refresh on this element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -15465,7 +49281,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "update", @@ -15473,7 +49319,43 @@ "desc" : "Performs an async request, updating this element with the response. If params are specified it uses POST, otherwise it uses GET.", "sig" : "(url, params, callback, discardUrl)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "url", + "type" : "Object/String/Function", + "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n
\num.update({
\n url: \"your-url.php\",
\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string
\n callback: yourFunction,
\n scope: yourObject, //(optional scope)
\n discardUrl: false,
\n nocache: false,
\n text: \"Loading...\",
\n timeout: 30,
\n scripts: false
\n});\n
\nThe only required property is url. The optional properties nocache, text and scripts\nare shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this UpdateManager instance.", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The parameters to pass as either a url encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse)", + "isOptional" : false + }, + { + "name" : "discardUrl", + "type" : "Boolean", + "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "updateElement", @@ -15481,7 +49363,43 @@ "desc" : "Static convenience method. This method is deprecated in favor of el.load({url:'foo.php', ...}).\nUsage:\n
Roo.UpdateManager.updateElement(\"my-div\", \"stuff.php\");
", "sig" : "(el, url, params, options)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "This has been deprecated: ", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element to update", + "isOptional" : false + }, + { + "name" : "url", + "type" : "String", + "desc" : "The url", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) Url encoded param string or an object of name/value pairs", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) A config object with any of the UpdateManager properties you want to set - for example: {disableCaching:true, indicatorText: \"Loading data...\"}", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -15495,7 +49413,43 @@ "desc" : "This is called when the transaction is completed and it's time to update the element - The BasicRenderer\nupdates the elements innerHTML with the responseText - To perform a custom render (i.e. XML or JSON processing),\ncreate an object with a \"render(el, response)\" method and pass it to setRenderer on the UpdateManager.", "sig" : "(el, response, updateManager, callback)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "Roo.Element", + "desc" : "The element being rendered", + "isOptional" : false + }, + { + "name" : "response", + "type" : "Object", + "desc" : "The YUI Connect response object", + "isOptional" : false + }, + { + "name" : "updateManager", + "type" : "UpdateManager", + "desc" : "The calling update manager", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "A callback that will need to be called if loadScripts is true on the UpdateManager", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -15585,49 +49539,236 @@ "type" : "function", "desc" : "Fires before a click is processed. Returns false to cancel the default action.", "sig" : "function (_self, index, node, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.View", + "desc" : "", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the target node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "The target node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The raw event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeselect", "type" : "function", "desc" : "Fires before a selection is made. If any handlers return false, the selection is cancelled.", "sig" : "function (_self, node, selections)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.View", + "desc" : "", + "isOptional" : false + }, + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "The node to be selected", + "isOptional" : false + }, + { + "name" : "selections", + "type" : "Array", + "desc" : "Array of currently selected nodes", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fires when a template node is clicked.", "sig" : "function (_self, index, node, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.View", + "desc" : "", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the target node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "The target node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The raw event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "contextmenu", "type" : "function", "desc" : "Fires when a template node is right clicked.", "sig" : "function (_self, index, node, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.View", + "desc" : "", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the target node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "The target node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The raw event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dblclick", "type" : "function", "desc" : "Fires when a template node is double clicked.", "sig" : "function (_self, index, node, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.View", + "desc" : "", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the target node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "The target node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The raw event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "preparedata", "type" : "function", "desc" : "Fires on every row to render, to allow you to change the data.", "sig" : "function (_self, data)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.View", + "desc" : "", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "to be rendered (change this)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "selectionchange", "type" : "function", "desc" : "Fires when the selected nodes change.", "sig" : "function (_self, selections)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.View", + "desc" : "", + "isOptional" : false + }, + { + "name" : "selections", + "type" : "Array", + "desc" : "Array of the selected nodes", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -15637,7 +49778,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -15645,7 +49804,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -15653,7 +49848,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearSelections", @@ -15661,7 +49886,25 @@ "desc" : "Clear all selections", "sig" : "(suppressEvent)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "suppressEvent", + "type" : "Boolean", + "desc" : "(optional) true to skip firing of the selectionchange event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "findItemFromChild", @@ -15669,7 +49912,31 @@ "desc" : "Returns the template node the passed child belongs to or null if it doesn't belong to one.", "sig" : "(node)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "The template node" + } + ] }, { "name" : "fireEvent", @@ -15677,7 +49944,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getEl", @@ -15685,7 +49982,24 @@ "desc" : "Returns the element this view is bound to.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] }, { "name" : "getNode", @@ -15693,7 +50007,31 @@ "desc" : "Gets a template node.", "sig" : "(nodeInfo)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "nodeInfo", + "type" : "HTMLElement/String/Number", + "desc" : "An HTMLElement template node, index of a template node or the id of a template node", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "The node or null if it wasn't found" + } + ] }, { "name" : "getNodes", @@ -15701,7 +50039,37 @@ "desc" : "Gets a range template nodes.", "sig" : "(startIndex, endIndex)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "startIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "endIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "An array of nodes" + } + ] }, { "name" : "getSelectedIndexes", @@ -15709,7 +50077,24 @@ "desc" : "Get the indexes of the selected nodes.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "" + } + ] }, { "name" : "getSelectedNodes", @@ -15717,7 +50102,24 @@ "desc" : "Get the currently selected nodes.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "An array of HTMLElements" + } + ] }, { "name" : "getSelectionCount", @@ -15725,7 +50127,24 @@ "desc" : "Get the number of selected nodes.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -15733,7 +50152,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "indexOf", @@ -15741,7 +50184,31 @@ "desc" : "Finds the index of the passed node", "sig" : "(nodeInfo)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "nodeInfo", + "type" : "HTMLElement/String/Number", + "desc" : "An HTMLElement template node, index of a template node or the id of a template node", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The index of the node or -1" + } + ] }, { "name" : "isSelected", @@ -15749,7 +50216,31 @@ "desc" : "Returns true if the passed node is selected", "sig" : "(node)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement/Number", + "desc" : "The node or node index", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "on", @@ -15757,7 +50248,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onBeforeLoad", @@ -15765,7 +50292,18 @@ "desc" : "onbeforeLoad - masks the loading area.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "prepareData", @@ -15773,7 +50311,25 @@ "desc" : "Function to override to reformat the data that is sent to\nthe template for each node.\nDEPRICATED - use the preparedata event handler.", "sig" : "(data)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "data", + "type" : "Array/Object", + "desc" : "The raw data (array of colData for a data model bound view or\na JSON object for an UpdateManager bound view).", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -15781,7 +50337,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "refresh", @@ -15789,7 +50356,18 @@ "desc" : "Refreshes the view. - called by datachanged on the store. - do not call directly.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "refreshNode", @@ -15797,7 +50375,25 @@ "desc" : "Refresh an individual node.", "sig" : "(index)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "releaseCapture", @@ -15805,7 +50401,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -15813,7 +50427,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "select", @@ -15821,7 +50465,37 @@ "desc" : "Selects nodes.", "sig" : "(nodeInfo, keepExisting, suppressEvent)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "nodeInfo", + "type" : "Array/HTMLElement/String/Number", + "desc" : "An HTMLElement template node, index of a template node, id of a template node or an array of any of those to select", + "isOptional" : false + }, + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) true to keep existing selections", + "isOptional" : false + }, + { + "name" : "suppressEvent", + "type" : "Boolean", + "desc" : "(optional) true to skip firing of the selectionchange vent", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setStore", @@ -15829,7 +50503,25 @@ "desc" : "Changes the data store this view uses and refresh the view.", "sig" : "(store)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "store", + "type" : "Store", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "un", @@ -15837,7 +50529,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "unselect", @@ -15845,7 +50567,37 @@ "desc" : "Unselects nodes.", "sig" : "(nodeInfo, keepExisting, suppressEvent)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "nodeInfo", + "type" : "Array/HTMLElement/String/Number", + "desc" : "An HTMLElement template node, index of a template node, id of a template node or an array of any of those to select", + "isOptional" : false + }, + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) true IGNORED (for campatibility with select)", + "isOptional" : false + }, + { + "name" : "suppressEvent", + "type" : "Boolean", + "desc" : "(optional) true to skip firing of the selectionchange vent", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -15900,7 +50652,20 @@ "type" : "function", "desc" : "Fires when this the componnt is built", "sig" : "function (c)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "c", + "type" : "Roo.XComponent", + "desc" : "the component", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -15910,7 +50675,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -15918,7 +50701,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "build", @@ -15926,7 +50745,31 @@ "desc" : "Build the registered modules.", "sig" : "(parent, optional)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "parent", + "type" : "Object", + "desc" : "element.", + "isOptional" : false + }, + { + "name" : "optional", + "type" : "Function", + "desc" : "method to call after module has been added.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "buildOrder", @@ -15934,7 +50777,24 @@ "desc" : "make a list of modules to build.", "sig" : "()\n{\n\n}", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "list of modules." + } + ] }, { "name" : "capture", @@ -15942,7 +50802,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "fireEvent", @@ -15950,7 +50840,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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", @@ -15958,7 +50878,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "overlayStrings", @@ -15966,7 +50910,31 @@ "desc" : "Overlay a set of modified strings onto a component\nThis is dependant on our builder exporting the strings and 'named strings' elements.", "sig" : "(element, associative)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "element", + "type" : "Object", + "desc" : "to overlay on - eg. Pman.Dialog.Login", + "isOptional" : false + }, + { + "name" : "associative", + "type" : "Object", + "desc" : "array of 'named' string and it's new value.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "preBuild", @@ -15974,7 +50942,18 @@ "desc" : "move modules into their correct place in the tree..", "sig" : "()\n{\n\n}", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "purgeListeners", @@ -15982,7 +50961,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "register", @@ -15990,7 +50980,18 @@ "desc" : "Register components to be built later.\n\nThis solves the following issues\n- Building is not done on page load, but after an authentication process has occured.\n- Interface elements are registered on page load\n- Parent Interface elements may not be loaded before child, so this handles that..\n\n\nexample:\n\nMyApp.register({\n order : '000001',\n module : 'Pman.Tab.projectMgr',\n region : 'center',\n parent : 'Pman.layout',\n disabled : false, // or use a function..\n })\n* @param {Object} details about module", "sig" : "()\n{\n\n}", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -15998,7 +50999,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -16006,7 +51025,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -16014,7 +51063,25 @@ "desc" : "render\nrender element to dom or tree", "sig" : "(optional)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "optional", + "type" : "Roo.Element|String|DomElement", + "desc" : "render to if parent is not set.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "toObject", @@ -16022,7 +51089,18 @@ "desc" : "convert a string to an object..\neg. 'AAA.BBB' -> finds AAA.BBB", "sig" : "()\n{\n\n}", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -16030,7 +51108,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -16068,7 +51176,43 @@ "desc" : "Applies the supplied values to the template and appends the new node(s) to el.", "sig" : "(el, values, returnElement)", "static" : false, - "memberOf" : "Roo.Template" + "memberOf" : "Roo.Template", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] }, { "name" : "apply", @@ -16076,7 +51220,18 @@ "desc" : "Alias for {@link #applyTemplate}", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Template" + "memberOf" : "Roo.Template", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "applySubTemplate", @@ -16084,7 +51239,37 @@ "desc" : "same as applyTemplate, except it's done to one of the subTemplates\nwhen using named templates, you can do:\n\nvar str = pl.applySubTemplate('your-name', values);", "sig" : "(id, values, parent)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "Number", + "desc" : "of the template", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "to apply to template", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Object", + "desc" : "(normaly the instance of this object)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "applyTemplate", @@ -16092,7 +51277,31 @@ "desc" : "Returns an HTML fragment of this template with the specified values applied.", "sig" : "(values)", "static" : false, - "memberOf" : "Roo.Template" + "memberOf" : "Roo.Template", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The HTML fragment" + } + ] }, { "name" : "compile", @@ -16100,7 +51309,18 @@ "desc" : "compile the template\n\nThis is not recursive, so I'm not sure how nested templates are really going to be handled..", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "from", @@ -16108,7 +51328,25 @@ "desc" : "Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML.", "sig" : "(el)", "static" : true, - "memberOf" : "Roo.Template" + "memberOf" : "Roo.Template", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement", + "desc" : "A DOM element or its id", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "insertAfter", @@ -16116,7 +51354,43 @@ "desc" : "Applies the supplied values to the template and inserts the new node(s) after el.", "sig" : "(el, values, returnElement)", "static" : false, - "memberOf" : "Roo.Template" + "memberOf" : "Roo.Template", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] }, { "name" : "insertBefore", @@ -16124,7 +51398,43 @@ "desc" : "Applies the supplied values to the template and inserts the new node(s) before el.", "sig" : "(el, values, returnElement)", "static" : false, - "memberOf" : "Roo.Template" + "memberOf" : "Roo.Template", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] }, { "name" : "insertFirst", @@ -16132,7 +51442,43 @@ "desc" : "Applies the supplied values to the template and inserts the new node(s) as the first child of el.", "sig" : "(el, values, returnElement)", "static" : false, - "memberOf" : "Roo.Template" + "memberOf" : "Roo.Template", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] }, { "name" : "overwrite", @@ -16140,7 +51486,43 @@ "desc" : "Applies the supplied values to the template and overwrites the content of el with the new node(s).", "sig" : "(el, values, returnElement)", "static" : false, - "memberOf" : "Roo.Template" + "memberOf" : "Roo.Template", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The context element", + "isOptional" : false + }, + { + "name" : "values", + "type" : "Object", + "desc" : "The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})", + "isOptional" : false + }, + { + "name" : "returnElement", + "type" : "Boolean", + "desc" : "(optional) true to return a Roo.Element (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement/Roo.Element", + "desc" : "The new node or Element" + } + ] }, { "name" : "set", @@ -16148,7 +51530,37 @@ "desc" : "Sets the HTML used as the template and optionally compiles it.", "sig" : "(html, compile)", "static" : false, - "memberOf" : "Roo.Template" + "memberOf" : "Roo.Template", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "compile", + "type" : "Boolean", + "desc" : "(optional) True to compile the template (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Template", + "desc" : "this" + } + ] } ] }, @@ -16217,11 +51629,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "html", @@ -16269,23 +51677,13 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "weight", "type" : "String", "desc" : "r) Weight of the message", - "memberOf" : "", - "optvals" : [ - "success", - "info", - "warning", - "danger" - ] + "memberOf" : "" }, { "name" : "xattr", @@ -16300,77 +51698,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -16380,7 +51921,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -16388,7 +51947,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -16396,7 +51991,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -16404,7 +52029,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -16412,7 +52048,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -16420,7 +52073,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -16428,7 +52098,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -16436,7 +52136,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -16444,7 +52168,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -16452,7 +52193,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -16460,7 +52218,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -16468,7 +52243,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -16476,7 +52262,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -16484,7 +52294,18 @@ "desc" : "Hide the Alert", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -16492,7 +52313,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -16500,7 +52332,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -16508,7 +52351,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -16516,7 +52395,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -16524,7 +52414,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -16532,7 +52440,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -16540,7 +52478,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -16548,7 +52504,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setHtml", @@ -16556,7 +52530,25 @@ "desc" : "Set the Body Message HTML", "sig" : "(html)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setIcon", @@ -16564,7 +52556,25 @@ "desc" : "Set the Icon of the alert", "sig" : "(see)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "see", + "type" : "String", + "desc" : "fontawsome names (name without the 'fa-' bit)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setTitle", @@ -16572,7 +52582,25 @@ "desc" : "Set the Title Message HTML", "sig" : "(html)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -16580,7 +52608,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -16588,7 +52627,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setWeight", @@ -16596,7 +52659,25 @@ "desc" : "Set the Weight of the alert", "sig" : "((success|info|warning|danger))", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "(success|info|warning|danger)", + "type" : "String", + "desc" : "weight", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", @@ -16604,7 +52685,18 @@ "desc" : "Show the Alert", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -16612,7 +52704,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -16620,7 +52729,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -16726,11 +52865,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -16760,11 +52895,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -16779,77 +52910,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -16859,7 +53133,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -16867,7 +53159,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -16875,7 +53203,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -16883,7 +53241,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -16891,7 +53260,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -16899,7 +53285,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -16907,7 +53310,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -16915,7 +53348,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -16923,7 +53380,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -16931,7 +53405,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -16939,7 +53430,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -16947,7 +53455,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -16955,7 +53474,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -16963,7 +53506,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -16971,7 +53525,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -16979,7 +53544,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -16987,7 +53563,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -16995,7 +53607,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -17003,7 +53626,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -17011,7 +53652,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -17019,7 +53690,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -17027,7 +53716,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -17035,7 +53742,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -17043,7 +53761,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -17051,7 +53793,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -17059,7 +53812,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -17067,7 +53837,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -17119,11 +53919,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -17153,11 +53949,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -17172,77 +53964,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -17252,7 +54187,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -17260,7 +54213,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -17268,7 +54257,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -17276,7 +54295,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -17284,7 +54314,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -17292,7 +54339,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -17300,7 +54364,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -17308,7 +54402,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -17316,7 +54434,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -17324,7 +54459,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -17332,7 +54484,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -17340,7 +54509,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -17348,7 +54528,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -17356,7 +54560,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -17364,7 +54579,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -17372,7 +54598,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -17380,7 +54617,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -17388,7 +54661,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -17396,7 +54680,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -17404,7 +54706,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -17412,7 +54744,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -17420,7 +54770,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -17428,7 +54796,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -17436,7 +54815,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -17444,7 +54847,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -17452,7 +54866,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -17460,7 +54891,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -17518,11 +54979,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "href", @@ -17582,11 +55039,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -17601,84 +55054,246 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "When a Brick is click", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Brick", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -17688,7 +55303,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -17696,7 +55329,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -17704,7 +55373,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -17712,7 +55411,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -17720,7 +55430,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -17728,7 +55455,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -17736,7 +55480,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -17744,7 +55518,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -17752,7 +55550,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -17760,7 +55575,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -17768,7 +55600,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -17776,7 +55625,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -17784,7 +55644,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -17792,7 +55676,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -17800,7 +55695,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -17808,7 +55714,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -17816,7 +55733,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -17824,7 +55777,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -17832,7 +55796,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -17840,7 +55822,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -17848,7 +55860,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -17856,7 +55886,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -17864,7 +55912,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -17872,7 +55931,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -17880,7 +55963,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -17888,7 +55982,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -17896,7 +56007,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -17924,19 +56065,7 @@ "name" : "badge_weight", "type" : "String", "desc" : "k) default (same as button)", - "memberOf" : "", - "optvals" : [ - "default", - "primary", - "secondary", - "success", - "info", - "warning", - "danger", - "link", - "light", - "dark" - ] + "memberOf" : "" }, { "name" : "can_build_overlaid", @@ -17996,11 +56125,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "href", @@ -18078,12 +56203,7 @@ "name" : "size", "type" : "String", "desc" : "s)", - "memberOf" : "", - "optvals" : [ - "lg", - "sm", - "xs" - ] + "memberOf" : "" }, { "name" : "style", @@ -18095,35 +56215,19 @@ "name" : "tag", "type" : "String", "desc" : "t)", - "memberOf" : "", - "optvals" : [ - "a", - "input", - "submit" - ] + "memberOf" : "" }, { "name" : "target", "type" : "String", "desc" : "r) target for a href.", - "memberOf" : "", - "optvals" : [ - "_self", - "_blank", - "_parent", - "_top", - "other" - ] + "memberOf" : "" }, { "name" : "theme", "type" : "String", "desc" : "w)", - "memberOf" : "", - "optvals" : [ - "default", - "glow" - ] + "memberOf" : "" }, { "name" : "toggle", @@ -18141,29 +56245,13 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "weight", "type" : "String", "desc" : "k) default", - "memberOf" : "", - "optvals" : [ - "default", - "primary", - "secondary", - "success", - "info", - "warning", - "danger", - "link", - "light", - "dark" - ] + "memberOf" : "" }, { "name" : "xattr", @@ -18178,98 +56266,304 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "When a button is pressed", "sig" : "function (btn, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "btn", + "type" : "Roo.bootstrap.Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dblclick", "type" : "function", "desc" : "When a button is double clicked", "sig" : "function (btn, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "btn", + "type" : "Roo.bootstrap.Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "toggle", "type" : "function", "desc" : "After the button has been toggles", "sig" : "function (btn, e, pressed)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "btn", + "type" : "Roo.bootstrap.Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + }, + { + "name" : "pressed", + "type" : "boolean", + "desc" : "(also available as button.pressed)", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -18279,7 +56573,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -18287,7 +56599,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -18295,7 +56643,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -18303,7 +56681,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -18311,7 +56700,18 @@ "desc" : "Disable this button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "enable", @@ -18319,7 +56719,18 @@ "desc" : "Enables this button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -18327,7 +56738,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -18335,7 +56776,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -18343,7 +56808,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -18351,7 +56833,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -18359,7 +56858,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getText", @@ -18367,7 +56883,18 @@ "desc" : "get the text of the first selected button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "getVisibilityEl", @@ -18375,7 +56902,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -18383,7 +56921,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -18391,7 +56953,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -18399,7 +56972,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isActive", @@ -18407,7 +56991,24 @@ "desc" : "get the current active state", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if it's active" + } + ] }, { "name" : "isVisible", @@ -18415,7 +57016,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -18423,7 +57035,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -18431,7 +57079,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -18439,7 +57098,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -18447,7 +57124,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -18455,7 +57162,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setActive", @@ -18463,7 +57188,25 @@ "desc" : "sets the active state on/off,", "sig" : "(state)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "state", + "type" : "Boolean", + "desc" : "(optional) Force a particular state", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDisabled", @@ -18471,7 +57214,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setText", @@ -18479,7 +57240,18 @@ "desc" : "set the text of the first selected button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -18487,7 +57259,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -18495,7 +57278,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -18503,7 +57310,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "toggleActive", @@ -18511,7 +57329,18 @@ "desc" : "toggles the current active state", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -18519,7 +57348,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -18527,7 +57373,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -18597,11 +57473,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -18643,11 +57515,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -18662,77 +57530,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -18742,7 +57753,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addItem", @@ -18750,7 +57779,18 @@ "desc" : "Add a button to the group (similar to NavItem API.)", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "addListener", @@ -18758,7 +57798,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -18766,7 +57842,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -18774,7 +57880,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -18782,7 +57899,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -18790,7 +57924,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -18798,7 +57949,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -18806,7 +57987,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -18814,7 +58019,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -18822,7 +58044,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -18830,7 +58069,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -18838,7 +58094,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -18846,7 +58113,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -18854,7 +58145,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -18862,7 +58164,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -18870,7 +58183,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -18878,7 +58202,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -18886,7 +58246,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -18894,7 +58265,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -18902,7 +58291,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -18910,7 +58329,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -18918,7 +58355,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -18926,7 +58381,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -18934,7 +58400,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -18942,7 +58432,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -18950,7 +58451,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -18958,7 +58476,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -18986,19 +58534,7 @@ "name" : "badge_weight", "type" : "String", "desc" : "k) default (same as button)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "default", - "primary", - "secondary", - "success", - "info", - "warning", - "danger", - "link", - "light", - "dark" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "can_build_overlaid", @@ -19064,11 +58600,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "href", @@ -19158,12 +58690,7 @@ "name" : "size", "type" : "String", "desc" : "s)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "lg", - "sm", - "xs" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "style", @@ -19175,35 +58702,19 @@ "name" : "tag", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "a", - "input", - "submit" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "target", "type" : "String", "desc" : "r) target for a href.", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "_self", - "_blank", - "_parent", - "_top", - "other" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "theme", "type" : "String", "desc" : "w)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "default", - "glow" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "toggle", @@ -19221,29 +58732,13 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "weight", "type" : "String", "desc" : "k) default", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "default", - "primary", - "secondary", - "success", - "info", - "warning", - "danger", - "link", - "light", - "dark" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "xattr", @@ -19258,112 +58753,350 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeselect", "type" : "function", "desc" : "When button is pressed, before show upload files dialog is shown", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploaderButton", + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "When a button is pressed", "sig" : "function (btn, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Button" + "memberOf" : "Roo.bootstrap.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "btn", + "type" : "Roo.bootstrap.Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dblclick", "type" : "function", "desc" : "When a button is double clicked", "sig" : "function (btn, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Button" + "memberOf" : "Roo.bootstrap.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "btn", + "type" : "Roo.bootstrap.Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fired when files have been selected,", "type" : "function", "desc" : "When a the download link is clicked", "sig" : "function (_self, Array)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploaderButton", + "desc" : "", + "isOptional" : false + }, + { + "name" : "Array", + "type" : "Array", + "desc" : "of files that have been uploaded", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "toggle", "type" : "function", "desc" : "After the button has been toggles", "sig" : "function (btn, e, pressed)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Button" + "memberOf" : "Roo.bootstrap.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "btn", + "type" : "Roo.bootstrap.Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + }, + { + "name" : "pressed", + "type" : "boolean", + "desc" : "(also available as button.pressed)", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -19373,7 +59106,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -19381,7 +59132,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -19389,7 +59176,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -19397,7 +59214,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -19405,7 +59233,18 @@ "desc" : "Disable this button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Button" + "memberOf" : "Roo.bootstrap.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "enable", @@ -19413,7 +59252,18 @@ "desc" : "Enables this button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Button" + "memberOf" : "Roo.bootstrap.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -19421,7 +59271,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -19429,7 +59309,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -19437,7 +59341,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -19445,7 +59366,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -19453,7 +59391,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getText", @@ -19461,7 +59416,18 @@ "desc" : "get the text of the first selected button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Button" + "memberOf" : "Roo.bootstrap.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "getVisibilityEl", @@ -19469,7 +59435,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -19477,7 +59454,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -19485,7 +59486,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -19493,7 +59505,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isActive", @@ -19501,7 +59524,24 @@ "desc" : "get the current active state", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Button" + "memberOf" : "Roo.bootstrap.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if it's active" + } + ] }, { "name" : "isVisible", @@ -19509,7 +59549,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -19517,7 +59568,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -19525,7 +59612,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -19533,7 +59631,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -19541,7 +59657,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -19549,7 +59695,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -19557,7 +59721,25 @@ "desc" : "addCard - add an Attachment to the uploader", "sig" : "(data)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "data", + "type" : "", + "desc" : "- the data about the image to upload\n\n{\n id : 123\n title : \"Title of file\",\n is_uploaded : false,\n src : \"http://.....\",\n srcfile : { the File upload object },\n mimetype : file.type,\n preview : false,\n is_deleted : 0\n .. any other data...\n }", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setActive", @@ -19565,7 +59747,25 @@ "desc" : "sets the active state on/off,", "sig" : "(state)", "static" : false, - "memberOf" : "Roo.bootstrap.Button" + "memberOf" : "Roo.bootstrap.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "state", + "type" : "Boolean", + "desc" : "(optional) Force a particular state", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDisabled", @@ -19573,7 +59773,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setText", @@ -19581,7 +59799,18 @@ "desc" : "set the text of the first selected button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Button" + "memberOf" : "Roo.bootstrap.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -19589,7 +59818,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -19597,7 +59837,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -19605,7 +59869,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "toggleActive", @@ -19613,7 +59888,18 @@ "desc" : "toggles the current active state", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Button" + "memberOf" : "Roo.bootstrap.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -19621,7 +59907,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -19629,7 +59932,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -19687,11 +60020,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -19703,11 +60032,7 @@ "name" : "loadMask", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "name", @@ -19721,6 +60046,12 @@ "desc" : "Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)", "memberOf" : "" }, + { + "name" : "store", + "type" : "Roo.data.Store", + "desc" : "The data source for the calendar", + "memberOf" : "" + }, { "name" : "style", "type" : "String", @@ -19737,11 +60068,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -19756,112 +60083,350 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "eventclick", "type" : "function", "desc" : "Fires when the mouse click an", "sig" : "function (_self, )\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Calendar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "", + "type" : "event", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "evententer", "type" : "function", "desc" : "Fires when mouse over an event", "sig" : "function (_self, Event)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Calendar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "Event", + "type" : "event", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "eventleave", "type" : "function", "desc" : "Fires when the mouse leaves an", "sig" : "function (_self, )\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Calendar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "", + "type" : "event", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "monthchange", "type" : "function", "desc" : "Fires when the displayed month changes", "sig" : "function (_self, date)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "DatePicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Date", + "desc" : "The selected month", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "select", "type" : "function", "desc" : "Fires when a date is selected", "sig" : "function (_self, date)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "DatePicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Date", + "desc" : "The selected date", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -19871,7 +60436,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -19879,7 +60462,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -19887,7 +60506,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -19895,7 +60544,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -19903,7 +60563,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -19911,7 +60588,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -19919,7 +60613,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -19927,7 +60651,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -19935,7 +60683,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -19943,7 +60708,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -19951,7 +60733,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -19959,7 +60758,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -19967,7 +60777,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -19975,7 +60809,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -19983,7 +60828,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -19991,7 +60847,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -19999,7 +60866,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -20007,7 +60910,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -20015,7 +60929,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -20023,7 +60955,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -20031,7 +60993,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -20039,7 +61019,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -20047,7 +61045,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -20055,7 +61064,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -20063,7 +61096,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -20071,7 +61115,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -20079,7 +61140,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -20131,86 +61222,31 @@ "name" : "display", "type" : "String", "desc" : "x)", - "memberOf" : "", - "optvals" : [ - "none", - "inline", - "inline-block", - "block", - "table", - "table-cell", - "table-row", - "flex", - "inline-flex" - ] + "memberOf" : "" }, { "name" : "display_lg", "type" : "String", "desc" : "x)", - "memberOf" : "", - "optvals" : [ - "none", - "inline", - "inline-block", - "block", - "table", - "table-cell", - "table-row", - "flex", - "inline-flex" - ] + "memberOf" : "" }, { "name" : "display_sm", "type" : "String", "desc" : "x)", - "memberOf" : "", - "optvals" : [ - "none", - "inline", - "inline-block", - "block", - "table", - "table-cell", - "table-row", - "flex", - "inline-flex" - ] + "memberOf" : "" }, { "name" : "display_xl", "type" : "String", "desc" : "x)", - "memberOf" : "", - "optvals" : [ - "none", - "inline", - "inline-block", - "block", - "table", - "table-cell", - "table-row", - "flex", - "inline-flex" - ] + "memberOf" : "" }, { "name" : "display_xs", "type" : "String", "desc" : "x)", - "memberOf" : "", - "optvals" : [ - "none", - "inline", - "inline-block", - "block", - "table", - "table-cell", - "table-row", - "flex", - "inline-flex" - ] + "memberOf" : "" }, { "name" : "footer", @@ -20234,41 +61270,19 @@ "name" : "header_size", "type" : "Number", "desc" : "5) H1 or H2 etc.. 0 indicates default", - "memberOf" : "", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5" - ] + "memberOf" : "" }, { "name" : "header_weight", "type" : "Number", "desc" : "k)", - "memberOf" : "", - "optvals" : [ - "primary", - "secondary", - "success", - "info", - "warning", - "danger", - "light", - "dark" - ] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "html", @@ -20286,106 +61300,43 @@ "name" : "margin", "type" : "String", "desc" : "o)", - "memberOf" : "", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5", - "auto" - ] + "memberOf" : "" }, { "name" : "margin_bottom", "type" : "String", "desc" : "o)", - "memberOf" : "", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5", - "auto" - ] + "memberOf" : "" }, { "name" : "margin_left", "type" : "String", "desc" : "o)", - "memberOf" : "", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5", - "auto" - ] + "memberOf" : "" }, { "name" : "margin_right", "type" : "String", "desc" : "o)", - "memberOf" : "", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5", - "auto" - ] + "memberOf" : "" }, { "name" : "margin_top", "type" : "String", "desc" : "o)", - "memberOf" : "", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5", - "auto" - ] + "memberOf" : "" }, { "name" : "margin_x", "type" : "String", "desc" : "o)", - "memberOf" : "", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5", - "auto" - ] + "memberOf" : "" }, { "name" : "margin_y", "type" : "String", "desc" : "o)", - "memberOf" : "", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5", - "auto" - ] + "memberOf" : "" }, { "name" : "name", @@ -20397,99 +61348,43 @@ "name" : "padding", "type" : "String", "desc" : "5)", - "memberOf" : "", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5" - ] + "memberOf" : "" }, { "name" : "padding_bottom", "type" : "String", "desc" : "5)", - "memberOf" : "", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5" - ] + "memberOf" : "" }, { "name" : "padding_left", "type" : "String", "desc" : "5)", - "memberOf" : "", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5" - ] + "memberOf" : "" }, { "name" : "padding_right", "type" : "String", "desc" : "5)", - "memberOf" : "", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5" - ] + "memberOf" : "" }, { "name" : "padding_top", "type" : "String", "desc" : "5)next_to_card", - "memberOf" : "", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5" - ] + "memberOf" : "" }, { "name" : "padding_x", "type" : "String", "desc" : "5)", - "memberOf" : "", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5" - ] + "memberOf" : "" }, { "name" : "padding_y", "type" : "String", "desc" : "5)", - "memberOf" : "", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5" - ] + "memberOf" : "" }, { "name" : "style", @@ -20519,27 +61414,13 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "weight", "type" : "String", "desc" : "k)", - "memberOf" : "", - "optvals" : [ - "primary", - "warning", - "info", - "danger", - "secondary", - "success", - "light", - "dark" - ] + "memberOf" : "" }, { "name" : "xattr", @@ -20554,98 +61435,316 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "cardover", "type" : "function", "desc" : "When a card element is dragged over ready to drop (return false to block dropable)", "sig" : "function (_self, data)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Card", + "desc" : "", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "from dragdrop", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "drop", "type" : "function", "desc" : "When a element a card is dropped", "sig" : "function (_self, move_card, position, next_to_card)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Card", + "desc" : "", + "isOptional" : false + }, + { + "name" : "move_card", + "type" : "Roo.bootstrap.Card", + "desc" : "the card being dropped?", + "isOptional" : false + }, + { + "name" : "position", + "type" : "String", + "desc" : "'above' or 'below'", + "isOptional" : false + }, + { + "name" : "next_to_card", + "type" : "Roo.bootstrap.Card", + "desc" : "What card position is relative to of 'false' for empty list.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enable", "type" : "function", "desc" : "Fires after the component is enabled.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rotate", "type" : "function", "desc" : "When a element a card is rotate", "sig" : "function (_self, n, rotate)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Card", + "desc" : "", + "isOptional" : false + }, + { + "name" : "n", + "type" : "Roo.Element", + "desc" : "the node being dropped?", + "isOptional" : false + }, + { + "name" : "rotate", + "type" : "Boolean", + "desc" : "status", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -20655,7 +61754,18 @@ "desc" : "accept card\n\n- card.acceptCard(move_card, info.position, info.card, info.items_n);", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "addEvents", @@ -20663,7 +61773,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -20671,7 +61799,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -20679,7 +61843,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -20687,7 +61881,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -20695,7 +61900,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -20703,7 +61925,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -20711,7 +61950,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -20719,7 +61988,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -20727,7 +62020,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getDropPoint", @@ -20735,7 +62045,18 @@ "desc" : "Decide whether to drop above or below a View node.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "getEl", @@ -20743,7 +62064,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -20751,7 +62089,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getTargetFromEvent", @@ -20759,7 +62114,18 @@ "desc" : "Part of the Roo.dd.DropZone interface. If no target node is found, the\n whole Element becomes the target, and this causes the drop gesture to append.\n\n Returns an object:\n {\n \n position : 'below' or 'above'\n card : relateive to card OBJECT (or true for no cards listed)\n items_n : relative to nth item in list\n card_n : relative to nth card in list\n }", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "getVisibilityEl", @@ -20767,7 +62133,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -20775,7 +62152,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -20783,7 +62184,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -20791,7 +62203,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -20799,7 +62222,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -20807,7 +62241,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -20815,7 +62285,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -20823,7 +62304,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -20831,7 +62330,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -20839,7 +62368,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -20847,7 +62394,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -20855,7 +62420,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -20863,7 +62439,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -20871,7 +62471,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -20879,7 +62490,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -20887,7 +62515,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -20915,11 +62573,7 @@ "name" : "clickable", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "cls", @@ -20949,11 +62603,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "html", @@ -20977,11 +62627,7 @@ "name" : "preventDefault", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "role", @@ -21011,11 +62657,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -21030,84 +62672,246 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "When a element is chick", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Element" + "memberOf" : "Roo.bootstrap.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -21117,7 +62921,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -21125,7 +62947,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -21133,7 +62991,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -21141,7 +63029,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -21149,7 +63048,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -21157,7 +63073,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -21165,7 +63098,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -21173,7 +63136,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -21181,7 +63168,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -21189,7 +63193,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -21197,7 +63218,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -21205,7 +63243,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -21213,7 +63262,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -21221,7 +63294,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -21229,7 +63313,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -21237,7 +63332,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -21245,7 +63351,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -21253,7 +63395,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -21261,7 +63414,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -21269,7 +63440,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -21277,7 +63478,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -21285,7 +63504,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -21293,7 +63530,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -21301,7 +63549,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -21309,7 +63581,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -21317,7 +63600,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -21325,7 +63625,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -21353,11 +63683,7 @@ "name" : "clickable", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "cls", @@ -21387,11 +63713,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "html", @@ -21415,11 +63737,7 @@ "name" : "preventDefault", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "role", @@ -21449,11 +63767,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -21468,84 +63782,246 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "When a element is chick", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Element" + "memberOf" : "Roo.bootstrap.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -21555,7 +64031,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -21563,7 +64057,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -21571,7 +64101,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -21579,7 +64139,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -21587,7 +64158,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -21595,7 +64183,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -21603,7 +64208,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -21611,7 +64246,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -21619,7 +64278,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -21627,7 +64303,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -21635,7 +64328,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -21643,7 +64353,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -21651,7 +64372,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -21659,7 +64404,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -21667,7 +64423,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -21675,7 +64442,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -21683,7 +64461,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -21691,7 +64505,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -21699,7 +64524,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -21707,7 +64550,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -21715,7 +64588,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -21723,7 +64614,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -21731,7 +64640,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -21739,7 +64659,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -21747,7 +64691,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -21755,7 +64710,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -21763,7 +64735,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -21791,11 +64793,7 @@ "name" : "clickable", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "cls", @@ -21825,11 +64823,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "html", @@ -21853,11 +64847,7 @@ "name" : "preventDefault", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "role", @@ -21887,11 +64877,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -21906,84 +64892,246 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "When a element is chick", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Element" + "memberOf" : "Roo.bootstrap.Element", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -21993,7 +65141,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -22001,7 +65167,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -22009,7 +65211,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -22017,7 +65249,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -22025,7 +65268,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -22033,7 +65293,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -22041,7 +65318,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -22049,7 +65356,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -22057,7 +65388,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -22065,7 +65413,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -22073,7 +65438,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -22081,7 +65463,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -22089,7 +65482,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -22097,7 +65514,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -22105,7 +65533,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -22113,7 +65552,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -22121,7 +65571,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -22129,7 +65615,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -22137,7 +65634,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -22145,7 +65660,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -22153,7 +65698,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -22161,7 +65724,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -22169,7 +65750,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -22177,7 +65769,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -22185,7 +65801,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -22193,7 +65820,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -22201,7 +65845,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -22229,19 +65903,7 @@ "name" : "badge_weight", "type" : "String", "desc" : "k) default (same as button)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "default", - "primary", - "secondary", - "success", - "info", - "warning", - "danger", - "link", - "light", - "dark" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "can_build_overlaid", @@ -22307,11 +65969,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "href", @@ -22395,12 +66053,7 @@ "name" : "size", "type" : "String", "desc" : "s)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "lg", - "sm", - "xs" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "style", @@ -22412,35 +66065,19 @@ "name" : "tag", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "a", - "input", - "submit" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "target", "type" : "String", "desc" : "r) target for a href.", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "_self", - "_blank", - "_parent", - "_top", - "other" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "theme", "type" : "String", "desc" : "w)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "default", - "glow" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "toggle", @@ -22458,29 +66095,13 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "weight", "type" : "String", "desc" : "k) default", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "default", - "primary", - "secondary", - "success", - "info", - "warning", - "danger", - "link", - "light", - "dark" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "xattr", @@ -22495,112 +66116,356 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "When a button is pressed", "sig" : "function (btn, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Button" + "memberOf" : "Roo.bootstrap.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "btn", + "type" : "Roo.bootstrap.Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dblclick", "type" : "function", "desc" : "When a button is double clicked", "sig" : "function (btn, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Button" + "memberOf" : "Roo.bootstrap.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "btn", + "type" : "Roo.bootstrap.Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "download", "type" : "function", "desc" : "When a the download link is clicked", "sig" : "function (_self, The)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Card", + "desc" : "", + "isOptional" : false + }, + { + "name" : "The", + "type" : "Object", + "desc" : "image information data contains", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enable", "type" : "function", "desc" : "Fires after the component is enabled.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "preview", "type" : "function", "desc" : "When a image is clicked on - and needs to display a slideshow or similar..", "sig" : "function (_self, The)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Card", + "desc" : "", + "isOptional" : false + }, + { + "name" : "The", + "type" : "Object", + "desc" : "image information data", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "toggle", "type" : "function", "desc" : "After the button has been toggles", "sig" : "function (btn, e, pressed)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Button" + "memberOf" : "Roo.bootstrap.Button", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "btn", + "type" : "Roo.bootstrap.Button", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + }, + { + "name" : "pressed", + "type" : "boolean", + "desc" : "(also available as button.pressed)", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -22610,7 +66475,25 @@ "desc" : "addCard - add an Attachment to the uploader", "sig" : "(data)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "data", + "type" : "", + "desc" : "- the data about the image to upload\n\n{\n id : 123\n title : \"Title of file\",\n is_uploaded : false,\n src : \"http://.....\",\n srcfile : { the File upload object },\n mimetype : file.type,\n preview : false,\n is_deleted : 0\n .. any other data...\n }", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addEvents", @@ -22618,7 +66501,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -22626,7 +66527,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -22634,7 +66571,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -22642,7 +66609,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -22650,7 +66628,18 @@ "desc" : "Disable this button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Button" + "memberOf" : "Roo.bootstrap.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "enable", @@ -22658,7 +66647,18 @@ "desc" : "Enables this button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Button" + "memberOf" : "Roo.bootstrap.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -22666,7 +66666,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -22674,7 +66704,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -22682,7 +66736,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -22690,7 +66761,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -22698,7 +66786,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getText", @@ -22706,7 +66811,18 @@ "desc" : "get the text of the first selected button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Button" + "memberOf" : "Roo.bootstrap.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "getVisibilityEl", @@ -22714,7 +66830,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -22722,7 +66849,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -22730,7 +66881,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -22738,7 +66900,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isActive", @@ -22746,7 +66919,24 @@ "desc" : "get the current active state", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Button" + "memberOf" : "Roo.bootstrap.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if it's active" + } + ] }, { "name" : "isVisible", @@ -22754,7 +66944,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -22762,7 +66963,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -22770,7 +67007,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -22778,7 +67026,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -22786,7 +67052,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -22794,7 +67090,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setActive", @@ -22802,7 +67116,25 @@ "desc" : "sets the active state on/off,", "sig" : "(state)", "static" : false, - "memberOf" : "Roo.bootstrap.Button" + "memberOf" : "Roo.bootstrap.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "state", + "type" : "Boolean", + "desc" : "(optional) Force a particular state", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDisabled", @@ -22810,7 +67142,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setText", @@ -22818,7 +67168,18 @@ "desc" : "set the text of the first selected button", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Button" + "memberOf" : "Roo.bootstrap.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -22826,7 +67187,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -22834,7 +67206,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -22842,7 +67238,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "toggleActive", @@ -22850,7 +67257,18 @@ "desc" : "toggles the current active state", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Button" + "memberOf" : "Roo.bootstrap.Button", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -22858,7 +67276,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -22866,7 +67301,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -22882,12 +67347,7 @@ "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "actionMode", @@ -22905,12 +67365,7 @@ "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", @@ -22958,11 +67413,7 @@ "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "checked", @@ -23022,11 +67473,7 @@ "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "groupId", @@ -23038,31 +67485,19 @@ "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "inline", @@ -23098,11 +67533,7 @@ "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", @@ -23300,11 +67731,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "vtype", @@ -23316,14 +67743,7 @@ "name" : "weight", "type" : "String", "desc" : "s) The text that appears beside the checkbox", - "memberOf" : "", - "optvals" : [ - "primary", - "warning", - "info", - "danger", - "success" - ] + "memberOf" : "" }, { "name" : "xattr", @@ -23344,147 +67764,462 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "check", "type" : "function", "desc" : "Fires when the element is checked or unchecked.", "sig" : "function (_self, checked)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.CheckBox", + "desc" : "This input", + "isOptional" : false + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "The new checked value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "childrenrendered", "type" : "function", "desc" : "Fires when the children have been rendered..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fires when the element is click.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.CheckBox", + "desc" : "This input", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "paste", "type" : "function", "desc" : "Fires after the user pastes into input", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -23494,7 +68229,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -23502,7 +68255,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -23510,7 +68299,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -23518,7 +68337,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -23526,7 +68356,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -23534,7 +68375,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -23542,7 +68400,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -23550,7 +68425,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -23558,7 +68463,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "get", @@ -23566,7 +68495,25 @@ "desc" : "fetch a CheckBox Group based on the group ID", "sig" : "(the)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "string", + "desc" : "group ID", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getChildContainer", @@ -23574,7 +68521,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -23582,7 +68546,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -23590,7 +68571,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -23598,7 +68596,24 @@ "desc" : "Returns the name of the field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] }, { "name" : "getRawValue", @@ -23606,7 +68621,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getValue", @@ -23614,7 +68646,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getVisibilityEl", @@ -23622,7 +68671,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -23630,7 +68690,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -23638,7 +68722,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -23646,7 +68741,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "inputEl", @@ -23654,7 +68760,18 @@ "desc" : "return the real input element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -23662,7 +68779,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -23670,7 +68798,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "markValid", @@ -23678,7 +68824,18 @@ "desc" : "Mark this field as valid", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -23686,7 +68843,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -23694,7 +68887,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "register", @@ -23702,7 +68906,25 @@ "desc" : "register a CheckBox Group", "sig" : "(the)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.CheckBox", + "desc" : "CheckBox to add", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "releaseCapture", @@ -23710,7 +68932,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -23718,7 +68958,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -23726,7 +68996,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -23734,7 +69022,18 @@ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setDisabled", @@ -23742,7 +69041,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setRawValue", @@ -23750,7 +69067,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setValue", @@ -23758,7 +69093,25 @@ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -23766,7 +69119,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -23774,7 +69138,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -23782,7 +69170,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -23790,7 +69189,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -23798,7 +69214,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "validate", @@ -23806,7 +69252,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -23814,7 +69277,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -23830,13 +69317,7 @@ "name" : "alert", "type" : "String", "desc" : "r) type alert (changes background / border...)", - "memberOf" : "", - "optvals" : [ - "success", - "info", - "warning", - "danger" - ] + "memberOf" : "" }, { "name" : "allowDomMove", @@ -23878,43 +69359,25 @@ "name" : "fa", "type" : "String", "desc" : ".) font awesome icon", - "memberOf" : "", - "optvals" : [ - "ban", - "check", - "..." - ] + "memberOf" : "" }, { "name" : "fasize", "type" : "Number", "desc" : ".) font awsome size", - "memberOf" : "", - "optvals" : [ - "1", - "2", - "...." - ] + "memberOf" : "" }, { "name" : "hidden", "type" : "Boolean", "desc" : "e) hide the element", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "html", @@ -23926,12 +69389,7 @@ "name" : "icon", "type" : "String", "desc" : ".) glyphicon name", - "memberOf" : "", - "optvals" : [ - "info-sign", - "check", - "..." - ] + "memberOf" : "" }, { "name" : "lg", @@ -23997,11 +69455,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -24028,77 +69482,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -24108,7 +69705,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -24116,7 +69731,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -24124,7 +69775,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -24132,7 +69813,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -24140,7 +69832,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -24148,7 +69857,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -24156,7 +69882,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -24164,7 +69920,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -24172,7 +69952,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -24180,7 +69977,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -24188,7 +70002,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -24196,7 +70027,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -24204,7 +70046,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -24212,7 +70078,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -24220,7 +70097,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -24228,7 +70116,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -24236,7 +70135,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -24244,7 +70179,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -24252,7 +70198,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -24260,7 +70224,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -24268,7 +70262,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -24276,7 +70288,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -24284,7 +70314,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -24292,7 +70333,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -24300,7 +70365,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -24308,7 +70384,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -24316,7 +70409,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -24332,12 +70455,7 @@ "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "actionMode", @@ -24355,12 +70473,7 @@ "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allQuery", @@ -24396,11 +70509,7 @@ "name" : "append", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "autoCreate", @@ -24412,11 +70521,7 @@ "name" : "autoFocus", "type" : "Boolean", "desc" : "e) auto focus the first item, default true", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "autocomplete", @@ -24458,21 +70563,13 @@ "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "caret", "type" : "String", "desc" : "r) BS3 only - carat fa name", - "memberOf" : "Roo.bootstrap.TriggerField", - "optvals" : [ - "search", - "calendar" - ] + "memberOf" : "Roo.bootstrap.TriggerField" }, { "name" : "cls", @@ -24556,11 +70653,7 @@ "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "forceSelection", @@ -24596,11 +70689,7 @@ "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hiddenName", @@ -24612,11 +70701,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "hideTrigger", @@ -24628,11 +70713,7 @@ "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidClass", @@ -24656,11 +70737,7 @@ "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", @@ -24792,21 +70869,13 @@ "name" : "mobileTouchView", "type" : "Boolean", "desc" : "e) show mobile touch view when using a mobile default true", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "mobile_restrict_height", "type" : "Boolean", "desc" : "e) restrict height for touch view", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "modalTitle", @@ -24824,11 +70893,7 @@ "name" : "multiple", "type" : "Boolean", "desc" : "e) ComboBobArray, default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "name", @@ -24888,11 +70953,7 @@ "name" : "removable", "type" : "Boolean", "desc" : "e) special filter default false", - "memberOf" : "Roo.bootstrap.TriggerField", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.TriggerField" }, { "name" : "resizable", @@ -24940,11 +71001,7 @@ "name" : "specialFilter", "type" : "Boolean", "desc" : "e) special filter default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "store", @@ -25022,11 +71079,7 @@ "name" : "useNativeIOS", "type" : "Boolean", "desc" : "e) render it as classic select for ios, not support dynamic load data (default false)", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "validClass", @@ -25086,11 +71139,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "vtype", @@ -25123,217 +71172,716 @@ "type" : "function", "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "afterremove", "type" : "function", "desc" : "Fires when the remove value from the combobox array", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforequery", "type" : "function", "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:", "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "query", + "type" : "String", + "desc" : "The query", + "isOptional" : false + }, + { + "name" : "forceAll", + "type" : "Boolean", + "desc" : "true to force \"all\" query", + "isOptional" : false + }, + { + "name" : "cancel", + "type" : "Boolean", + "desc" : "true to cancel the query", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "The query event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeselect", "type" : "function", "desc" : "Fires before a list item is selected. Return false to cancel the selection.", "sig" : "function (combo, record, index)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The data record returned from the underlying store", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the selected item in the dropdown list", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "childrenrendered", "type" : "function", "desc" : "Fires when the children have been rendered..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "collapse", "type" : "function", "desc" : "Fires when the dropdown list is collapsed", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "edit", "type" : "function", "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)", "sig" : "function (combo, record)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record|false", + "desc" : "The data record returned from the underlying store (or false on nothing selected)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enable", "type" : "function", "desc" : "Fires after the component is enabled.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "expand", "type" : "function", "desc" : "Fires when the dropdown list is expanded", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "paste", "type" : "function", "desc" : "Fires after the user pastes into input", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "remove", "type" : "function", "desc" : "Fires when the remove value from the combobox array", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "select", "type" : "function", "desc" : "Fires when a list item is selected", "sig" : "function (combo, record, index)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The data record returned from the underlying store (or false on clear)", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the selected item in the dropdown list", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialfilter", "type" : "function", "desc" : "Fires when specialfilter", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "tick", "type" : "function", "desc" : "Fires when tick the element", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "touchviewdisplay", "type" : "function", "desc" : "Fires when touch view require special display (default is using displayField)", "sig" : "function (combo, cfg)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "cfg", + "type" : "Object", + "desc" : "set html .", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -25343,7 +71891,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -25351,7 +71917,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "autoSize", @@ -25359,7 +71961,18 @@ "desc" : "", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.TriggerField" + "memberOf" : "Roo.bootstrap.TriggerField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -25367,7 +71980,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -25375,7 +72018,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "clearValue", @@ -25383,7 +72037,18 @@ "desc" : "Clears any text/value currently set in the field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "collapse", @@ -25391,7 +72056,18 @@ "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -25399,7 +72075,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -25407,7 +72094,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "doQuery", @@ -25415,7 +72119,31 @@ "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.", "sig" : "(query, forceAll)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "query", + "type" : "String", + "desc" : "The SQL query to execute", + "isOptional" : false + }, + { + "name" : "forceAll", + "type" : "Boolean", + "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enable", @@ -25423,7 +72151,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "expand", @@ -25431,7 +72176,18 @@ "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -25439,7 +72195,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -25447,7 +72233,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -25455,7 +72265,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -25463,7 +72290,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -25471,7 +72315,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -25479,7 +72340,24 @@ "desc" : "Returns the name of the field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] }, { "name" : "getRawValue", @@ -25487,7 +72365,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getValue", @@ -25495,7 +72390,24 @@ "desc" : "Returns the currently selected field value or empty string if no value is set.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "value The selected value" + } + ] }, { "name" : "getVisibilityEl", @@ -25503,7 +72415,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -25511,7 +72434,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -25519,7 +72466,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -25527,7 +72485,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "inputEl", @@ -25535,7 +72504,18 @@ "desc" : "return the real input element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isExpanded", @@ -25543,7 +72523,18 @@ "desc" : "Returns true if the dropdown list is expanded, else false.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -25551,7 +72542,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -25559,7 +72561,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "markValid", @@ -25567,7 +72587,18 @@ "desc" : "Mark this field as valid", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -25575,7 +72606,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onTriggerClick", @@ -25583,7 +72650,25 @@ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.bootstrap.TriggerField" + "memberOf" : "Roo.bootstrap.TriggerField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -25591,7 +72676,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -25599,7 +72695,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -25607,7 +72721,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -25615,7 +72759,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -25623,7 +72785,18 @@ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "select", @@ -25631,7 +72804,31 @@ "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", "sig" : "(index, scrollIntoView)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The zero-based index of the list item to select", + "isOptional" : false + }, + { + "name" : "scrollIntoView", + "type" : "Boolean", + "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "selectByValue", @@ -25639,7 +72836,37 @@ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", "sig" : "(value, scrollIntoView)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The data value of the item to select", + "isOptional" : false + }, + { + "name" : "scrollIntoView", + "type" : "Boolean", + "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value matched an item in the list, else false" + } + ] }, { "name" : "setDisabled", @@ -25647,7 +72874,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setEditable", @@ -25655,7 +72900,25 @@ "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Boolean", + "desc" : "True to allow the user to directly edit the field text", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setFromData", @@ -25663,7 +72926,25 @@ "desc" : "Sets the value of the field based on a object which is related to the record format for the store.", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Object", + "desc" : "the value to set as. or false on reset?", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRawValue", @@ -25671,7 +72952,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setValue", @@ -25679,7 +72978,25 @@ "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The value to match", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -25687,7 +73004,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -25695,7 +73023,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -25703,7 +73055,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -25711,7 +73074,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -25719,7 +73099,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "validate", @@ -25727,7 +73137,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -25735,7 +73162,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -25787,11 +73238,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -25821,11 +73268,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "" }, { "name" : "xattr", @@ -25840,77 +73283,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "childrenrendered", "type" : "function", "desc" : "Fires when the children have been rendered..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -25920,7 +73506,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -25928,7 +73532,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -25936,7 +73576,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -25944,7 +73614,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -25952,7 +73633,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -25960,7 +73658,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -25968,7 +73683,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -25976,7 +73721,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -25984,7 +73753,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "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" : "getEl", @@ -25992,7 +73778,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -26000,7 +73803,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -26008,7 +73828,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -26016,7 +73847,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -26024,7 +73879,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -26032,7 +73898,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -26040,7 +73917,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -26048,7 +73936,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -26056,7 +73980,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -26064,7 +73999,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -26072,7 +74025,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -26080,7 +74063,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -26088,7 +74089,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -26096,7 +74115,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -26104,7 +74134,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -26112,7 +74166,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -26120,7 +74185,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "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" : "un", @@ -26128,7 +74210,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -26144,13 +74256,7 @@ "name" : "alert", "type" : "String", "desc" : "r) type alert (changes background / border...)", - "memberOf" : "", - "optvals" : [ - "success", - "info", - "warning", - "danger" - ] + "memberOf" : "" }, { "name" : "allowDomMove", @@ -26168,11 +74274,7 @@ "name" : "clickable", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "cls", @@ -26202,21 +74304,13 @@ "name" : "expandable", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "expanded", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "fa", @@ -26240,21 +74334,13 @@ "name" : "hidden", "type" : "Boolean", "desc" : "e) hide the element", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "html", @@ -26266,12 +74352,7 @@ "name" : "icon", "type" : "String", "desc" : ".) glyphicon name", - "memberOf" : "", - "optvals" : [ - "info-sign", - "check", - "..." - ] + "memberOf" : "" }, { "name" : "jumbotron", @@ -26295,15 +74376,7 @@ "name" : "panel", "type" : "String", "desc" : "r) render as panel - type - primary/success.....", - "memberOf" : "", - "optvals" : [ - "default", - "primary", - "success", - "info", - "warning", - "danger" - ] + "memberOf" : "" }, { "name" : "rheader", @@ -26315,12 +74388,7 @@ "name" : "sticky", "type" : "String", "desc" : "h) block to use as footer or body- needs css-bootstrap/sticky-footer.css", - "memberOf" : "", - "optvals" : [ - "footer", - "wrap", - "push" - ] + "memberOf" : "" }, { "name" : "style", @@ -26332,12 +74400,7 @@ "name" : "tag", "type" : "String", "desc" : "n) type of HTML tag.", - "memberOf" : "", - "optvals" : [ - "header", - "aside", - "section" - ] + "memberOf" : "" }, { "name" : "tooltip", @@ -26349,22 +74412,13 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "well", "type" : "String", "desc" : "d) a well, large, small or medium.", - "memberOf" : "", - "optvals" : [ - "lg", - "sm", - "md" - ] + "memberOf" : "" }, { "name" : "xattr", @@ -26379,98 +74433,286 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "When a element is chick", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Container", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "collapse", "type" : "function", "desc" : "After the panel has been collapsed", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Container", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "expand", "type" : "function", "desc" : "After the panel has been expand", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Container", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -26480,7 +74722,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -26488,7 +74748,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -26496,7 +74792,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -26504,7 +74830,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -26512,7 +74849,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -26520,7 +74874,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -26528,7 +74899,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -26536,7 +74937,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -26544,7 +74969,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -26552,7 +74994,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -26560,7 +75019,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -26568,7 +75044,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -26576,7 +75063,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -26584,7 +75095,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -26592,7 +75114,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -26600,7 +75133,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -26608,7 +75152,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -26616,7 +75196,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -26624,7 +75215,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -26632,7 +75241,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -26640,7 +75279,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -26648,7 +75305,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -26656,7 +75331,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -26664,7 +75350,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -26672,7 +75382,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -26680,7 +75401,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -26688,7 +75426,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -26704,12 +75472,7 @@ "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "actionMode", @@ -26727,12 +75490,7 @@ "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", @@ -26786,11 +75544,7 @@ "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "cls", @@ -26856,11 +75610,7 @@ "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "format", @@ -26872,31 +75622,19 @@ "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidClass", @@ -26926,11 +75664,7 @@ "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", @@ -27164,11 +75898,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "vtype", @@ -27201,147 +75931,474 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeselect", "type" : "function", "desc" : "Fires when before select a date.", "sig" : "function (_self, date)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DateField", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Mixed", + "desc" : "The date value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "childrenrendered", "type" : "function", "desc" : "Fires when the children have been rendered..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "paste", "type" : "function", "desc" : "Fires after the user pastes into input", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "select", "type" : "function", "desc" : "Fires when select a date.", "sig" : "function (_self, date)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DateField", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Mixed", + "desc" : "The date value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires when this field show.", "sig" : "function (_self, date)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DateField", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Mixed", + "desc" : "The date value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -27351,7 +76408,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -27359,7 +76434,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -27367,7 +76478,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -27375,7 +76516,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -27383,7 +76535,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -27391,7 +76554,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -27399,7 +76579,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -27407,7 +76604,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -27415,7 +76642,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -27423,7 +76674,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -27431,7 +76699,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -27439,7 +76724,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -27447,7 +76749,24 @@ "desc" : "Returns the name of the field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] }, { "name" : "getRawValue", @@ -27455,7 +76774,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getValue", @@ -27463,7 +76799,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getVisibilityEl", @@ -27471,7 +76824,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -27479,7 +76843,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -27487,7 +76875,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -27495,7 +76894,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "inputEl", @@ -27503,7 +76913,18 @@ "desc" : "return the real input element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -27511,7 +76932,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -27519,7 +76951,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "markValid", @@ -27527,7 +76977,18 @@ "desc" : "Mark this field as valid", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -27535,7 +76996,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -27543,7 +77040,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -27551,7 +77059,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -27559,7 +77085,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -27567,7 +77123,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -27575,7 +77149,18 @@ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setDisabled", @@ -27583,7 +77168,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setRawValue", @@ -27591,7 +77194,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setValue", @@ -27599,7 +77220,25 @@ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -27607,7 +77246,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -27615,7 +77265,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -27623,7 +77297,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -27631,7 +77316,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -27639,7 +77341,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "validate", @@ -27647,7 +77379,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -27655,7 +77404,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -27701,11 +77474,7 @@ "name" : "dayAllowBlank", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "dayFormat", @@ -27735,21 +77504,13 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "" }, { "name" : "labelWidth", @@ -27791,11 +77552,7 @@ "name" : "monthAllowBlank", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "monthFormat", @@ -27831,11 +77588,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -27847,11 +77600,7 @@ "name" : "yearAllowBlank", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "yearFormat", @@ -27872,105 +77621,318 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "days", "type" : "function", "desc" : "getting the data of days", "sig" : "function (_self, days)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DateSplitField", + "desc" : "", + "isOptional" : false + }, + { + "name" : "days", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "years", "type" : "function", "desc" : "getting the data of years", "sig" : "function (_self, years)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DateSplitField", + "desc" : "", + "isOptional" : false + }, + { + "name" : "years", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -27980,7 +77942,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -27988,7 +77968,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -27996,7 +78012,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -28004,7 +78050,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -28012,7 +78069,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -28020,7 +78094,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -28028,7 +78119,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -28036,7 +78157,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -28044,7 +78189,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -28052,7 +78214,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -28060,7 +78239,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -28068,7 +78264,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -28076,7 +78283,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -28084,7 +78315,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -28092,7 +78334,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -28100,7 +78353,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -28108,7 +78372,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -28116,7 +78398,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -28124,7 +78442,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -28132,7 +78461,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -28140,7 +78487,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -28148,7 +78525,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -28156,7 +78551,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -28164,7 +78577,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -28172,7 +78596,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -28180,7 +78628,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -28188,7 +78647,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -28196,7 +78672,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -28254,11 +78760,7 @@ "name" : "editable", "type" : "Boolean", "desc" : "e) allow edit when upload a image default true", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "fieldLabel", @@ -28270,21 +78772,13 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "labelAlign", "type" : "String", "desc" : "p) default left", - "memberOf" : "", - "optvals" : [ - "left", - "top" - ] + "memberOf" : "" }, { "name" : "labelWidth", @@ -28380,11 +78874,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -28399,161 +78889,514 @@ "type" : "function", "desc" : "Fire when xhr load exception", "sig" : "function (_self, xhr)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "desc" : "", + "isOptional" : false + }, + { + "name" : "xhr", + "type" : "XMLHttpRequest", + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeselectfile", "type" : "function", "desc" : "Fire before select file", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fire after click the image", "sig" : "function (_self, file)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "desc" : "", + "isOptional" : false + }, + { + "name" : "file", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "edit", "type" : "function", "desc" : "Fire when upload a image and editable set to true", "sig" : "function (_self, file)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "desc" : "", + "isOptional" : false + }, + { + "name" : "file", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enable", "type" : "function", "desc" : "Fires after the component is enabled.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "exception", "type" : "function", "desc" : "Fire when xhr load exception", "sig" : "function (_self, xhr)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "desc" : "", + "isOptional" : false + }, + { + "name" : "xhr", + "type" : "XMLHttpRequest", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "initial", "type" : "function", "desc" : "Fire when initial the DocumentManager", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "inspect", "type" : "function", "desc" : "inspect selected file", "sig" : "function (_self, file)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "desc" : "", + "isOptional" : false + }, + { + "name" : "file", + "type" : "File", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "prepare", "type" : "function", "desc" : "prepare the form data", "sig" : "function (_self, formData)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "desc" : "", + "isOptional" : false + }, + { + "name" : "formData", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "previewrendered", "type" : "function", "desc" : "Fire when preview rendered", "sig" : "function (_self, file)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "desc" : "", + "isOptional" : false + }, + { + "name" : "file", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "process", "type" : "function", "desc" : "Fire before process file", "sig" : "function (_self, file)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "desc" : "", + "isOptional" : false + }, + { + "name" : "file", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "refresh", "type" : "function", "desc" : "Fire after refresh the file", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "remove", "type" : "function", "desc" : "Fire when remove the file", "sig" : "function (_self, file)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentManager", + "desc" : "", + "isOptional" : false + }, + { + "name" : "file", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -28563,7 +79406,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -28571,7 +79432,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -28579,7 +79476,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -28587,7 +79514,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -28595,7 +79533,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -28603,7 +79558,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -28611,7 +79583,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -28619,7 +79621,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -28627,7 +79653,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -28635,7 +79678,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -28643,7 +79703,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -28651,7 +79728,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -28659,7 +79747,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -28667,7 +79779,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -28675,7 +79798,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -28683,7 +79817,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -28691,7 +79836,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -28699,7 +79880,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -28707,7 +79899,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -28715,7 +79925,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -28723,7 +79963,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -28731,7 +79989,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -28739,7 +80015,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -28747,7 +80034,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -28755,7 +80066,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -28763,7 +80085,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -28771,7 +80110,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -28823,11 +80192,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -28857,11 +80222,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -28876,98 +80237,280 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fire after click", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentSlider", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "initial", "type" : "function", "desc" : "Fire after initEvent", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentSlider", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "update", "type" : "function", "desc" : "Fire after update", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentSlider", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -28977,7 +80520,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -28985,7 +80546,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -28993,7 +80590,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -29001,7 +80628,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -29009,7 +80647,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -29017,7 +80672,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -29025,7 +80697,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -29033,7 +80735,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -29041,7 +80767,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -29049,7 +80792,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -29057,7 +80817,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -29065,7 +80842,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -29073,7 +80861,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -29081,7 +80893,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -29089,7 +80912,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -29097,7 +80931,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -29105,7 +80950,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -29113,7 +80994,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -29121,7 +81013,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -29129,7 +81039,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -29137,7 +81077,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -29145,7 +81103,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -29153,7 +81129,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -29161,7 +81148,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -29169,7 +81180,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -29177,7 +81199,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -29185,7 +81224,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -29237,11 +81306,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -29259,21 +81324,13 @@ "name" : "showDownload", "type" : "Boolean", "desc" : "e) show download button (default true)", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "showTrash", "type" : "Boolean", "desc" : "e) show trash button (default true)", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "style", @@ -29291,11 +81348,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -29310,105 +81363,300 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fire after click", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentViewer", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "download", "type" : "function", "desc" : "Fire after download button", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentViewer", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enable", "type" : "function", "desc" : "Fires after the component is enabled.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "initial", "type" : "function", "desc" : "Fire after initEvent", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentViewer", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "trash", "type" : "function", "desc" : "Fire after trash button", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DocumentViewer", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -29418,7 +81666,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -29426,7 +81692,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -29434,7 +81736,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -29442,7 +81774,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -29450,7 +81793,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -29458,7 +81818,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -29466,7 +81843,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -29474,7 +81881,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -29482,7 +81913,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -29490,7 +81938,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -29498,7 +81963,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -29506,7 +81988,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -29514,7 +82007,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -29522,7 +82039,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -29530,7 +82058,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -29538,7 +82077,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -29546,7 +82096,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -29554,7 +82140,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -29562,7 +82159,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -29570,7 +82185,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -29578,7 +82223,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -29586,7 +82249,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -29594,7 +82275,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -29602,7 +82294,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -29610,7 +82326,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -29618,7 +82345,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -29626,7 +82370,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -29654,11 +82428,7 @@ "name" : "clickable", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "cls", @@ -29688,11 +82458,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "html", @@ -29716,11 +82482,7 @@ "name" : "preventDefault", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "role", @@ -29750,11 +82512,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -29769,84 +82527,246 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "When a element is chick", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -29856,7 +82776,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -29864,7 +82802,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -29872,7 +82846,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -29880,7 +82884,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -29888,7 +82903,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -29896,7 +82928,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -29904,7 +82953,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -29912,7 +82991,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -29920,7 +83023,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -29928,7 +83048,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -29936,7 +83073,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -29944,7 +83098,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -29952,7 +83117,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -29960,7 +83149,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -29968,7 +83168,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -29976,7 +83187,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -29984,7 +83206,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -29992,7 +83250,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -30000,7 +83269,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -30008,7 +83295,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -30016,7 +83333,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -30024,7 +83359,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -30032,7 +83385,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -30040,7 +83404,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -30048,7 +83436,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -30056,7 +83455,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -30064,7 +83480,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -30092,11 +83538,7 @@ "name" : "clickable", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "cls", @@ -30126,11 +83568,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "html", @@ -30154,11 +83592,7 @@ "name" : "preventDefault", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "role", @@ -30188,11 +83622,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -30207,84 +83637,246 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "When a element is chick", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -30294,7 +83886,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -30302,7 +83912,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -30310,7 +83956,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -30318,7 +83994,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -30326,7 +84013,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -30334,7 +84038,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -30342,7 +84063,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -30350,7 +84101,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -30358,7 +84133,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -30366,7 +84158,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -30374,7 +84183,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -30382,7 +84208,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -30390,7 +84227,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -30398,7 +84259,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -30406,7 +84278,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -30414,7 +84297,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -30422,7 +84316,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -30430,7 +84360,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -30438,7 +84379,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -30446,7 +84405,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -30454,7 +84443,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -30462,7 +84469,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -30470,7 +84495,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -30478,7 +84514,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -30486,7 +84546,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -30494,7 +84565,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -30502,7 +84590,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -30518,11 +84636,7 @@ "name" : "allowBlank", "type" : "Boolean", "desc" : "e) target allowBlank default true", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "allowDomMove", @@ -30564,11 +84678,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "html", @@ -30586,11 +84696,7 @@ "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "" }, { "name" : "invalidClass", @@ -30644,11 +84750,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -30663,91 +84765,266 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.FieldLabel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.FieldLabel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -30757,7 +85034,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -30765,7 +85060,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -30773,7 +85104,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -30781,7 +85142,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -30789,7 +85161,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -30797,7 +85186,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -30805,7 +85211,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -30813,7 +85249,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "get", @@ -30821,7 +85281,25 @@ "desc" : "fetch a FieldLabel Group based on the target", "sig" : "(target)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "target", + "type" : "string", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getChildContainer", @@ -30829,7 +85307,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -30837,7 +85332,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -30845,7 +85357,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -30853,7 +85382,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -30861,7 +85401,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -30869,7 +85433,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -30877,7 +85452,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -30885,7 +85471,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -30893,7 +85490,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "markValid", @@ -30901,7 +85516,18 @@ "desc" : "Mark this field as valid", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -30909,7 +85535,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -30917,7 +85579,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "register", @@ -30925,7 +85598,25 @@ "desc" : "register a FieldLabel Group", "sig" : "(the)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.FieldLabel", + "desc" : "FieldLabel to add", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "releaseCapture", @@ -30933,7 +85624,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -30941,7 +85650,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -30949,7 +85688,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -30957,7 +85714,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -30965,7 +85740,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -30973,7 +85759,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -30981,7 +85791,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -30989,7 +85810,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -30997,7 +85835,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -31061,11 +85929,7 @@ "name" : "errorMask", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "fileUpload", @@ -31077,11 +85941,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "labelAlign", @@ -31153,11 +86013,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -31172,105 +86028,324 @@ "type" : "function", "desc" : "Fires when an action is completed.", "sig" : "function (_self, action)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Form", + "desc" : "", + "isOptional" : false + }, + { + "name" : "action", + "type" : "Action", + "desc" : "The action that completed", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "actionfailed", "type" : "function", "desc" : "Fires when an action fails.", "sig" : "function (_self, action)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Form", + "desc" : "", + "isOptional" : false + }, + { + "name" : "action", + "type" : "Action", + "desc" : "The action that failed", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeaction", "type" : "function", "desc" : "Fires before any action is performed. Return false to cancel the action.", "sig" : "function (_self, action)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Form", + "desc" : "", + "isOptional" : false + }, + { + "name" : "action", + "type" : "Action", + "desc" : "The action to be performed", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "clientvalidation", "type" : "function", "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state", "sig" : "function (_self, valid)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Form", + "desc" : "", + "isOptional" : false + }, + { + "name" : "valid", + "type" : "Boolean", + "desc" : "true if the form has passed client-side validation", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -31280,7 +86355,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -31288,7 +86381,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -31296,7 +86425,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -31304,7 +86463,24 @@ "desc" : "Clears all invalid messages in this form.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "destroy", @@ -31312,7 +86488,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -31320,7 +86507,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "doAction", @@ -31328,7 +86532,37 @@ "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.", "sig" : "(actionName, options)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "actionName", + "type" : "String", + "desc" : "The name of the action type", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) The options to pass to the action. All of the config options listed\nbelow are supported by both the submit and load actions unless otherwise noted (custom actions could also\naccept other config options):\n
\nProperty          Type             Description\n----------------  ---------------  ----------------------------------------------------------------------------------\nurl               String           The url for the action (defaults to the form's url)\nmethod            String           The form method to use (defaults to the form's method, or POST if not defined)\nparams            String/Object    The params to pass (defaults to the form's baseParams, or none if not defined)\nclientValidation  Boolean          Applies to submit only.  Pass true to call form.isValid() prior to posting to\n                                   validate the form on the client (defaults to false)\n
", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -31336,7 +86570,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "findField", @@ -31344,7 +86595,31 @@ "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The value to search for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Field" + } + ] }, { "name" : "fireEvent", @@ -31352,7 +86627,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -31360,7 +86665,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -31368,7 +86697,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -31376,7 +86722,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getFieldValues", @@ -31384,7 +86747,24 @@ "desc" : "Returns the fields in this form as an object with key/value pairs.\nThis differs from getValues as it calls getValue on each child item, rather than using dom data.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "" + } + ] }, { "name" : "getId", @@ -31392,7 +86772,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getValues", @@ -31400,7 +86797,31 @@ "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.", "sig" : "(asString)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "asString", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -31408,7 +86829,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -31416,7 +86848,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -31424,7 +86880,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -31432,7 +86899,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isDirty", @@ -31440,7 +86918,24 @@ "desc" : "Returns true if any fields in this form have changed since their original load.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] }, { "name" : "isValid", @@ -31448,7 +86943,24 @@ "desc" : "Returns true if client-side validation on the form is successful.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] }, { "name" : "isVisible", @@ -31456,7 +86968,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -31464,7 +86987,31 @@ "desc" : "Mark fields in this form invalid in bulk.", "sig" : "(errors)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "errors", + "type" : "Array/Object", + "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "on", @@ -31472,7 +87019,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -31480,7 +87063,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -31488,7 +87082,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -31496,7 +87108,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -31504,7 +87146,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -31512,7 +87172,24 @@ "desc" : "Resets this form.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "setDisabled", @@ -31520,7 +87197,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setValues", @@ -31528,7 +87223,31 @@ "desc" : "Set values for fields in this form in bulk.", "sig" : "(values)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "values", + "type" : "Array/Object", + "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "setVisibilityEl", @@ -31536,7 +87255,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -31544,7 +87274,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -31552,7 +87306,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -31560,7 +87325,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -31568,7 +87350,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -31656,11 +87468,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -31696,11 +87504,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -31715,84 +87519,240 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "The img click event for the img.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -31802,7 +87762,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -31810,7 +87788,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -31818,7 +87832,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -31826,7 +87870,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -31834,7 +87889,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -31842,7 +87914,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -31850,7 +87939,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -31858,7 +87977,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -31866,7 +88009,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -31874,7 +88034,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -31882,7 +88059,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -31890,7 +88084,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -31898,7 +88103,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -31906,7 +88135,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -31914,7 +88154,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -31922,7 +88173,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -31930,7 +88192,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -31938,7 +88236,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -31946,7 +88255,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -31954,7 +88281,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -31962,7 +88319,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -31970,7 +88345,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -31978,7 +88371,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -31986,7 +88390,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -31994,7 +88422,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -32002,7 +88441,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -32010,7 +88466,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -32062,11 +88548,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "html", @@ -32078,15 +88560,7 @@ "name" : "level", "type" : "Number", "desc" : "6) default 1", - "memberOf" : "", - "optvals" : [ - "1", - "2", - "3", - "4", - "5", - "6" - ] + "memberOf" : "" }, { "name" : "listeners", @@ -32116,11 +88590,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -32135,77 +88605,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -32215,7 +88828,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -32223,7 +88854,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -32231,7 +88898,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -32239,7 +88936,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -32247,7 +88955,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -32255,7 +88980,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -32263,7 +89005,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -32271,7 +89043,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -32279,7 +89075,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -32287,7 +89100,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -32295,7 +89125,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -32303,7 +89150,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -32311,7 +89169,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -32319,7 +89201,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -32327,7 +89220,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -32335,7 +89239,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -32343,7 +89258,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -32351,7 +89302,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -32359,7 +89321,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -32367,7 +89347,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -32375,7 +89385,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -32383,7 +89411,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -32391,7 +89437,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -32399,7 +89456,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -32407,7 +89488,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -32415,7 +89507,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -32423,7 +89532,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -32439,12 +89578,7 @@ "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "actionMode", @@ -32462,12 +89596,7 @@ "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", @@ -32515,11 +89644,7 @@ "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "cls", @@ -32573,21 +89698,13 @@ "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "height", @@ -32599,11 +89716,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "html", @@ -32615,11 +89728,7 @@ "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidClass", @@ -32637,11 +89746,7 @@ "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", @@ -32767,15 +89872,7 @@ "name" : "resize", "type" : "string", "desc" : "l)", - "memberOf" : "Roo.bootstrap.TextArea", - "optvals" : [ - "none", - "both", - "horizontal", - "vertical", - "inherit", - "initial" - ] + "memberOf" : "Roo.bootstrap.TextArea" }, { "name" : "rows", @@ -32865,11 +89962,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "vtype", @@ -32887,11 +89980,7 @@ "name" : "wrap", "type" : "string", "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a form", - "memberOf" : "Roo.bootstrap.TextArea", - "optvals" : [ - "soft", - "hard" - ] + "memberOf" : "Roo.bootstrap.TextArea" }, { "name" : "xattr", @@ -32912,210 +90001,620 @@ "type" : "function", "desc" : "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "autosave", "type" : "function", "desc" : "Auto save the htmlEditor value as a file into Events", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforepush", "type" : "function", "desc" : "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push.", "sig" : "function (_self, html)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "html", + "type" : "String", + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforesync", "type" : "function", "desc" : "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync.", "sig" : "function (_self, html)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "", "sig" : "function ()\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "", "sig" : "function ()\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [], + "returns" : [] }, { "name" : "childrenrendered", "type" : "function", "desc" : "Fires when the children have been rendered..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "editmodechange", "type" : "function", "desc" : "Fires when the editor switches edit modes", "sig" : "function (_self, sourceEdit)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "sourceEdit", + "type" : "Boolean", + "desc" : "True if source edit, false if standard editing.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "editorevent", "type" : "function", "desc" : "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enable", "type" : "function", "desc" : "Fires after the component is enabled.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "firstfocus", "type" : "function", "desc" : "Fires when on first focus - needed by toolbars..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "", "sig" : "function ()\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "initialize", "type" : "function", "desc" : "Fires when the editor is fully initialized (including the iframe)", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "paste", "type" : "function", "desc" : "Fires after the user pastes into input", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "push", "type" : "function", "desc" : "Fires when the iframe editor is updated with content from the textarea.", "sig" : "function (_self, html)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "savedpreview", "type" : "function", "desc" : "preview the saved version of htmlEditor", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "", "sig" : "function ()\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [], + "returns" : [] }, { "name" : "sync", "type" : "function", "desc" : "Fires when the textarea is updated with content from the editor iframe.", "sig" : "function (_self, html)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -33125,7 +90624,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -33133,7 +90650,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -33141,7 +90694,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -33149,7 +90732,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.TextArea" + "memberOf" : "Roo.bootstrap.TextArea", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "createToolbar", @@ -33157,7 +90751,25 @@ "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.", "sig" : "(editor)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "editor", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", @@ -33165,7 +90777,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -33173,7 +90796,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -33181,7 +90821,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -33189,7 +90846,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -33197,7 +90884,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -33205,7 +90916,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -33213,7 +90941,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -33221,7 +90966,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -33229,7 +90991,24 @@ "desc" : "Returns the name of the field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] }, { "name" : "getRawValue", @@ -33237,7 +91016,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getValue", @@ -33245,7 +91041,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getVisibilityEl", @@ -33253,7 +91066,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -33261,7 +91085,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -33269,7 +91117,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -33277,7 +91136,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "inputEl", @@ -33285,7 +91155,18 @@ "desc" : "return the real textarea element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.TextArea" + "memberOf" : "Roo.bootstrap.TextArea", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -33293,7 +91174,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -33301,7 +91193,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.bootstrap.TextArea" + "memberOf" : "Roo.bootstrap.TextArea", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "markValid", @@ -33309,7 +91219,18 @@ "desc" : "Mark this field as valid", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.TextArea" + "memberOf" : "Roo.bootstrap.TextArea", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -33317,7 +91238,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -33325,7 +91282,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -33333,7 +91301,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -33341,7 +91327,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -33349,7 +91365,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -33357,7 +91391,18 @@ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setDisabled", @@ -33365,7 +91410,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setRawValue", @@ -33373,7 +91436,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setValue", @@ -33381,7 +91462,25 @@ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -33389,7 +91488,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -33397,7 +91507,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -33405,7 +91539,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "toggleSourceEdit", @@ -33413,7 +91558,25 @@ "desc" : "Toggles the editor between standard and source edit mode.", "sig" : "(sourceEdit)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "sourceEdit", + "type" : "Boolean", + "desc" : "(optional) True for source edit, false for standard", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "tooltipEl", @@ -33421,7 +91584,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -33429,7 +91609,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "validate", @@ -33437,7 +91647,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -33445,7 +91672,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -33515,11 +91766,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "href", @@ -33579,13 +91826,7 @@ "name" : "target", "type" : "String", "desc" : "p)target for a href.", - "memberOf" : "", - "optvals" : [ - "_self", - "_blank", - "_parent", - "_top" - ] + "memberOf" : "" }, { "name" : "tooltip", @@ -33597,11 +91838,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -33622,91 +91859,260 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "The img click event for the img.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "load", "type" : "function", "desc" : "The when any image loads", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -33716,7 +92122,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -33724,7 +92148,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -33732,7 +92192,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -33740,7 +92230,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -33748,7 +92249,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -33756,7 +92274,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -33764,7 +92299,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -33772,7 +92337,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -33780,7 +92369,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -33788,7 +92394,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -33796,7 +92419,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -33804,7 +92444,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -33812,7 +92463,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -33820,7 +92495,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -33828,7 +92514,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -33836,7 +92533,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -33844,7 +92552,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -33852,7 +92596,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -33860,7 +92615,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -33868,7 +92641,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -33876,7 +92679,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -33884,7 +92705,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setSrc", @@ -33892,7 +92731,25 @@ "desc" : "Sets the url of the image - used to update it", "sig" : "(url)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "url", + "type" : "String", + "desc" : "the url of the image", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -33900,7 +92757,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -33908,7 +92776,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -33916,7 +92808,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -33924,7 +92827,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -33932,7 +92852,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -33948,12 +92898,7 @@ "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "" }, { "name" : "actionMode", @@ -33971,12 +92916,7 @@ "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "" }, { "name" : "allowBlank", @@ -34018,11 +92958,7 @@ "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "" }, { "name" : "cls", @@ -34076,41 +93012,25 @@ "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "" }, { "name" : "invalidClass", @@ -34134,11 +93054,7 @@ "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "" }, { "name" : "labelWidth", @@ -34330,11 +93246,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "vtype", @@ -34361,133 +93273,416 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "childrenrendered", "type" : "function", "desc" : "Fires when the children have been rendered..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "paste", "type" : "function", "desc" : "Fires after the user pastes into input", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -34497,7 +93692,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -34505,7 +93718,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -34513,7 +93762,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -34521,7 +93800,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -34529,7 +93819,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -34537,7 +93838,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -34545,7 +93863,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -34553,7 +93888,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -34561,7 +93926,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -34569,7 +93958,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -34577,7 +93983,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -34585,7 +94008,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -34593,7 +94033,24 @@ "desc" : "Returns the name of the field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] }, { "name" : "getRawValue", @@ -34601,7 +94058,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getValue", @@ -34609,7 +94083,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getVisibilityEl", @@ -34617,7 +94108,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -34625,7 +94127,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -34633,7 +94159,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -34641,7 +94178,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "inputEl", @@ -34649,7 +94197,18 @@ "desc" : "return the real input element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -34657,7 +94216,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -34665,7 +94235,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "markValid", @@ -34673,7 +94261,18 @@ "desc" : "Mark this field as valid", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -34681,7 +94280,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -34689,7 +94324,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -34697,7 +94343,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -34705,7 +94369,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -34713,7 +94407,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -34721,7 +94433,18 @@ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setDisabled", @@ -34729,7 +94452,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setRawValue", @@ -34737,7 +94478,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setValue", @@ -34745,7 +94504,25 @@ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -34753,7 +94530,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -34761,7 +94549,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -34769,7 +94581,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -34777,7 +94600,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -34785,7 +94625,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "validate", @@ -34793,7 +94663,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -34801,7 +94688,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -34877,11 +94788,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "isAutoInitial", @@ -34941,11 +94848,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -34960,84 +94863,246 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "layout", "type" : "function", "desc" : "Fire after layout the items", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LayoutMasonry", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -35047,7 +95112,43 @@ "desc" : "Sets position of item in DOM", "sig" : "(item, x, y, isInstant)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "item", + "type" : "Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "- horizontal position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "- vertical position", + "isOptional" : false + }, + { + "name" : "isInstant", + "type" : "Boolean", + "desc" : "- disables transitions", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addBrick", @@ -35055,7 +95156,25 @@ "desc" : "adds a Masonry Brick", "sig" : "(the)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.MasonryBrick", + "desc" : "masonry brick to add", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addEvents", @@ -35063,7 +95182,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -35071,7 +95208,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -35079,7 +95252,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearAll", @@ -35087,7 +95290,18 @@ "desc" : "clear all the Masonry Brick", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -35095,7 +95309,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -35103,7 +95328,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -35111,7 +95353,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -35119,7 +95378,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -35127,7 +95416,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "get", @@ -35135,7 +95448,25 @@ "desc" : "fetch a Masonry Layout based on the masonry layout ID", "sig" : "(the)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "string", + "desc" : "masonry layout to add", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getChildContainer", @@ -35143,7 +95474,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -35151,7 +95499,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -35159,7 +95524,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -35167,7 +95549,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -35175,7 +95568,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -35183,7 +95600,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -35191,7 +95619,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -35199,7 +95638,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -35207,7 +95657,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -35215,7 +95701,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "register", @@ -35223,7 +95720,25 @@ "desc" : "register a Masonry Brick", "sig" : "(the)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.MasonryBrick", + "desc" : "masonry brick to add", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "register", @@ -35231,7 +95746,25 @@ "desc" : "register a Masonry Layout", "sig" : "(the)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.LayoutMasonry", + "desc" : "masonry layout to add", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "releaseCapture", @@ -35239,7 +95772,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "removeBrick", @@ -35247,7 +95798,25 @@ "desc" : "remove a Masonry Brick", "sig" : "(the)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.MasonryBrick", + "desc" : "masonry brick to remove", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeListener", @@ -35255,7 +95824,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -35263,7 +95862,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -35271,7 +95888,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -35279,7 +95914,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -35287,7 +95933,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -35295,7 +95965,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -35303,7 +95984,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -35311,7 +96009,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -35369,11 +96097,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "isAutoInitial", @@ -35451,11 +96175,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -35470,77 +96190,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -35550,7 +96413,25 @@ "desc" : "", "sig" : "(colSpan)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "colSpan", + "type" : "Number", + "desc" : "- number of columns the element spans", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "_postLayout", @@ -35558,7 +96439,18 @@ "desc" : "Any logic you want to do after each layout,\ni.e. size the container", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "_processLayoutQueue", @@ -35566,7 +96458,43 @@ "desc" : "Sets position of item in DOM", "sig" : "(item, x, y, isInstant)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "item", + "type" : "Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "- horizontal position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "- vertical position", + "isOptional" : false + }, + { + "name" : "isInstant", + "type" : "Boolean", + "desc" : "- disables transitions", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addEvents", @@ -35574,7 +96502,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -35582,7 +96528,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -35590,7 +96572,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -35598,7 +96610,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -35606,7 +96629,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -35614,7 +96654,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -35622,7 +96679,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -35630,7 +96717,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -35638,7 +96749,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -35646,7 +96774,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -35654,7 +96799,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -35662,7 +96824,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -35670,7 +96843,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -35678,7 +96875,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -35686,7 +96894,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -35694,7 +96913,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -35702,7 +96932,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -35710,7 +96976,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -35718,7 +96995,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -35726,7 +97021,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -35734,7 +97059,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -35742,7 +97085,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -35750,7 +97111,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -35758,7 +97130,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -35766,7 +97162,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -35774,7 +97181,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -35782,7 +97206,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -35852,11 +97306,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "href", @@ -35886,11 +97336,7 @@ "name" : "preventDefault", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "style", @@ -35902,13 +97348,7 @@ "name" : "target", "type" : "String", "desc" : "p) target for a href.", - "memberOf" : "", - "optvals" : [ - "_self", - "_blank", - "_parent", - "_top" - ] + "memberOf" : "" }, { "name" : "tooltip", @@ -35920,11 +97360,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -35939,84 +97375,240 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "The img click event for the img.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -36026,7 +97618,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -36034,7 +97644,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -36042,7 +97688,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -36050,7 +97726,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -36058,7 +97745,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -36066,7 +97770,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -36074,7 +97795,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -36082,7 +97833,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -36090,7 +97865,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -36098,7 +97890,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -36106,7 +97915,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -36114,7 +97940,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -36122,7 +97959,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -36130,7 +97991,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -36138,7 +98010,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -36146,7 +98029,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -36154,7 +98048,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -36162,7 +98092,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -36170,7 +98111,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -36178,7 +98137,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -36186,7 +98175,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -36194,7 +98201,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -36202,7 +98227,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -36210,7 +98246,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -36218,7 +98278,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -36226,7 +98297,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -36234,7 +98322,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -36310,11 +98428,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "latitude", @@ -36398,11 +98512,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -36423,168 +98533,522 @@ "type" : "function", "desc" : "Fires when OverlayView Draw", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "OverlayViewHide", "type" : "function", "desc" : "Fires when OverlayView Draw", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "OverlayViewOnAdd", "type" : "function", "desc" : "Fires when OverlayView Draw", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "OverlayViewOnRemove", "type" : "function", "desc" : "Fires when OverlayView Draw", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "OverlayViewShow", "type" : "function", "desc" : "Fires when OverlayView Draw", "sig" : "function (_self, cpx)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "cpx", + "type" : "Pixel", + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires when the map hide.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "initial", "type" : "function", "desc" : "Fires when the picker initialized.", "sig" : "function (_self, location)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "location", + "type" : "Google Location", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "loadexception", "type" : "function", "desc" : "Fires when load google lib failed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mapClick", "type" : "function", "desc" : "Fires when click the map.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Map event", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mapRightClick", "type" : "function", "desc" : "Fires when right click the map.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Map event", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "markerClick", "type" : "function", "desc" : "Fires when click the marker.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Map event", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "markerRightClick", "type" : "function", "desc" : "Fires when right click the marker.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Map event", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "positionchanged", "type" : "function", "desc" : "Fires when the picker position changed.", "sig" : "function (_self, location)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "location", + "type" : "Google Location", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires when the map resize.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires when the map show.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.LocationPicker", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -36594,7 +99058,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -36602,7 +99084,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -36610,7 +99128,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -36618,7 +99166,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -36626,7 +99185,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -36634,7 +99210,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -36642,7 +99235,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -36650,7 +99273,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -36658,7 +99305,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -36666,7 +99330,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -36674,7 +99355,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -36682,7 +99380,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -36690,7 +99399,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -36698,7 +99431,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -36706,7 +99450,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -36714,7 +99469,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -36722,7 +99488,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -36730,7 +99532,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -36738,7 +99551,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -36746,7 +99577,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -36754,7 +99615,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -36762,7 +99641,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -36770,7 +99667,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -36778,7 +99686,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -36786,7 +99718,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -36794,7 +99737,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -36802,7 +99762,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -36818,12 +99808,7 @@ "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "actionMode", @@ -36841,12 +99826,7 @@ "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", @@ -36888,11 +99868,7 @@ "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "cls", @@ -36958,31 +99934,19 @@ "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "html", @@ -36994,11 +99958,7 @@ "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidClass", @@ -37022,11 +99982,7 @@ "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", @@ -37146,15 +100102,7 @@ "name" : "resize", "type" : "string", "desc" : "l)", - "memberOf" : "Roo.bootstrap.TextArea", - "optvals" : [ - "none", - "both", - "horizontal", - "vertical", - "inherit", - "initial" - ] + "memberOf" : "Roo.bootstrap.TextArea" }, { "name" : "rows", @@ -37238,11 +100186,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "vtype", @@ -37254,11 +100198,7 @@ "name" : "wrap", "type" : "string", "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a form", - "memberOf" : "Roo.bootstrap.TextArea", - "optvals" : [ - "soft", - "hard" - ] + "memberOf" : "Roo.bootstrap.TextArea" }, { "name" : "xattr", @@ -37279,133 +100219,416 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "childrenrendered", "type" : "function", "desc" : "Fires when the children have been rendered..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "paste", "type" : "function", "desc" : "Fires after the user pastes into input", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -37415,7 +100638,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -37423,7 +100664,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -37431,7 +100708,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -37439,7 +100746,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.TextArea" + "memberOf" : "Roo.bootstrap.TextArea", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -37447,7 +100765,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -37455,7 +100784,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -37463,7 +100809,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -37471,7 +100834,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -37479,7 +100872,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -37487,7 +100904,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -37495,7 +100929,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -37503,7 +100954,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -37511,7 +100979,24 @@ "desc" : "Returns the name of the field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] }, { "name" : "getRawValue", @@ -37519,7 +101004,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getValue", @@ -37527,7 +101029,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getVisibilityEl", @@ -37535,7 +101054,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -37543,7 +101073,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -37551,7 +101105,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -37559,7 +101124,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "inputEl", @@ -37567,7 +101143,18 @@ "desc" : "return the real textarea element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.TextArea" + "memberOf" : "Roo.bootstrap.TextArea", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -37575,7 +101162,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -37583,7 +101181,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.bootstrap.TextArea" + "memberOf" : "Roo.bootstrap.TextArea", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "markValid", @@ -37591,7 +101207,18 @@ "desc" : "Mark this field as valid", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.TextArea" + "memberOf" : "Roo.bootstrap.TextArea", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -37599,7 +101226,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -37607,7 +101270,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -37615,7 +101289,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -37623,7 +101315,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -37631,7 +101353,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -37639,7 +101379,18 @@ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setDisabled", @@ -37647,7 +101398,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setRawValue", @@ -37655,7 +101424,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setValue", @@ -37663,7 +101450,25 @@ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -37671,7 +101476,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -37679,7 +101495,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -37687,7 +101527,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -37695,7 +101546,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -37703,7 +101571,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "validate", @@ -37711,7 +101609,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -37719,7 +101634,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -37777,11 +101716,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "href", @@ -37823,11 +101758,7 @@ "name" : "placetitle", "type" : "String", "desc" : "m)", - "memberOf" : "", - "optvals" : [ - "center", - "bottom" - ] + "memberOf" : "" }, { "name" : "preventDefault", @@ -37839,16 +101770,7 @@ "name" : "size", "type" : "String", "desc" : "e)", - "memberOf" : "", - "optvals" : [ - "xs", - "sm", - "md", - "md-left", - "md-right", - "tall", - "wide" - ] + "memberOf" : "" }, { "name" : "style", @@ -37878,11 +101800,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -37897,84 +101815,246 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "When a MasonryBrick is clcik", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.MasonryBrick", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -37984,7 +102064,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -37992,7 +102090,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -38000,7 +102134,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -38008,7 +102172,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -38016,7 +102191,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -38024,7 +102216,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -38032,7 +102241,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -38040,7 +102279,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "get", @@ -38048,7 +102311,25 @@ "desc" : "fetch a masonry brick based on the masonry brick ID", "sig" : "(the)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "string", + "desc" : "masonry brick to add", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getChildContainer", @@ -38056,7 +102337,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -38064,7 +102362,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -38072,7 +102387,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -38080,7 +102412,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -38088,7 +102431,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -38096,7 +102463,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -38104,7 +102482,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -38112,7 +102501,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -38120,7 +102520,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -38128,7 +102564,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "register", @@ -38136,7 +102583,25 @@ "desc" : "register a Masonry Brick", "sig" : "(the)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.MasonryBrick", + "desc" : "masonry brick to add", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "releaseCapture", @@ -38144,7 +102609,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -38152,7 +102635,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -38160,7 +102673,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -38168,7 +102699,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -38176,7 +102725,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -38184,7 +102744,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -38192,7 +102776,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -38200,7 +102795,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -38208,7 +102820,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -38272,31 +102914,19 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "hideTrigger", "type" : "bool", "desc" : "e) default false - hide the carret for trigger.", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "isLink", "type" : "bool", "desc" : "e) the menu has link disable auto expand and collaspe (default false)", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "listeners", @@ -38320,11 +102950,7 @@ "name" : "stopEvent", "type" : "bool", "desc" : "e) Stop event after trigger press (default true)", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "style", @@ -38342,22 +102968,13 @@ "name" : "type", "type" : "String", "desc" : "u) type of menu", - "memberOf" : "", - "optvals" : [ - "dropdown", - "treeview", - "submenu" - ] + "memberOf" : "" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -38372,105 +102989,342 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforehide", "type" : "function", "desc" : "Fires before this menu is hidden (return false to block)", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeshow", "type" : "function", "desc" : "Fires before this menu is displayed (return false to block)", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)", "sig" : "function (_self, menuItem, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after this menu is hidden", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "itemclick", "type" : "function", "desc" : "Fires when a menu item contained in this menu is clicked", "sig" : "function (baseItem, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "baseItem", + "type" : "Roo.menu.BaseItem", + "desc" : "The BaseItem that was clicked", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseout", "type" : "function", "desc" : "Fires when the mouse exits this menu", "sig" : "function (_self, e, menuItem)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseover", "type" : "function", "desc" : "Fires when the mouse is hovering over this menu", "sig" : "function (_self, e, menuItem)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after this menu is displayed", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -38480,7 +103334,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -38488,7 +103360,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -38496,7 +103404,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -38504,7 +103442,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -38512,7 +103461,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -38520,7 +103486,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -38528,7 +103511,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -38536,7 +103549,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -38544,7 +103581,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -38552,7 +103606,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -38560,7 +103631,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -38568,7 +103656,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -38576,7 +103675,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -38584,7 +103707,25 @@ "desc" : "Hides this menu and optionally all parent menus", "sig" : "(deep)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "initEvents", @@ -38592,7 +103733,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -38600,7 +103752,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -38608,7 +103771,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -38616,7 +103815,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -38624,7 +103834,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -38632,7 +103860,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -38640,7 +103898,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -38648,7 +103924,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -38656,7 +103950,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -38664,7 +103969,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -38672,7 +104001,37 @@ "desc" : "Displays this menu relative to another element", "sig" : "(element, position, parentMenu)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "element", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element to align to", + "isOptional" : false + }, + { + "name" : "position", + "type" : "String", + "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)", + "isOptional" : false + }, + { + "name" : "parentMenu", + "type" : "Roo.menu.Menu", + "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "showAt", @@ -38680,7 +104039,31 @@ "desc" : "Displays this menu at a specific xy position", "sig" : "(xyPosition, parentMenu)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "xyPosition", + "type" : "Array", + "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)", + "isOptional" : false + }, + { + "name" : "parentMenu", + "type" : "Roo.menu.Menu", + "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "tooltipEl", @@ -38688,7 +104071,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -38696,7 +104096,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -38760,11 +104190,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "href", @@ -38824,11 +104250,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -38843,84 +104265,246 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "The raw click event for the entire grid.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.MenuItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -38930,7 +104514,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -38938,7 +104540,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -38946,7 +104584,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -38954,7 +104622,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -38962,7 +104641,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -38970,7 +104666,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -38978,7 +104691,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -38986,7 +104729,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -38994,7 +104761,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -39002,7 +104786,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -39010,7 +104811,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -39018,7 +104836,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -39026,7 +104855,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -39034,7 +104887,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -39042,7 +104906,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -39050,7 +104925,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -39058,7 +104944,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -39066,7 +104988,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -39074,7 +105007,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -39082,7 +105033,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -39090,7 +105071,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -39098,7 +105097,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -39106,7 +105123,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -39114,7 +105142,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -39122,7 +105174,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -39130,7 +105193,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -39138,7 +105218,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -39152,7 +105262,25 @@ "desc" : "Returns a {@link Roo.menu.Menu} object", "sig" : "(menu)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "menu", + "type" : "String/Object", + "desc" : "The string menu id, an existing menu object reference, or a Menu config that will\nbe used to generate and return a new Menu instance.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hideAll", @@ -39160,7 +105288,18 @@ "desc" : "Hides all menus that are currently visible", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -39212,11 +105351,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -39246,11 +105381,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -39265,77 +105396,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -39345,7 +105619,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -39353,7 +105645,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -39361,7 +105689,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -39369,7 +105727,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -39377,7 +105746,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -39385,7 +105771,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -39393,7 +105796,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -39401,7 +105834,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -39409,7 +105866,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -39417,7 +105891,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -39425,7 +105916,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -39433,7 +105941,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -39441,7 +105960,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -39449,7 +105992,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -39457,7 +106011,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -39465,7 +106030,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -39473,7 +106049,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -39481,7 +106093,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -39489,7 +106112,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -39497,7 +106138,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -39505,7 +106176,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -39513,7 +106202,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -39521,7 +106228,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -39529,7 +106247,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -39537,7 +106279,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -39545,7 +106298,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -39553,7 +106323,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -39587,11 +106387,7 @@ "name" : "closable", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "cls", @@ -39621,21 +106417,13 @@ "name" : "fixed", "type" : "Boolean", "desc" : "e) default false, fix the bar at the top", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "html", @@ -39671,23 +106459,13 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "weight", "type" : "String", "desc" : "r) default info", - "memberOf" : "", - "optvals" : [ - "info", - "success", - "warning", - "danger" - ] + "memberOf" : "" }, { "name" : "xattr", @@ -39702,77 +106480,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -39782,7 +106703,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -39790,7 +106729,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -39798,7 +106773,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -39806,7 +106811,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -39814,7 +106830,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -39822,7 +106855,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -39830,7 +106880,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -39838,7 +106918,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -39846,7 +106950,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -39854,7 +106975,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -39862,7 +107000,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -39870,7 +107025,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -39878,7 +107044,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -39886,7 +107076,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -39894,7 +107095,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -39902,7 +107114,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -39910,7 +107133,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -39918,7 +107177,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -39926,7 +107196,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -39934,7 +107222,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -39942,7 +107260,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -39950,7 +107286,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -39958,7 +107312,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -39966,7 +107331,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -39974,7 +107363,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -39982,7 +107382,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -39990,7 +107407,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -40004,7 +107451,49 @@ "desc" : "Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert).\nIf a callback function is passed it will be called after the user clicks the button, and the\nid of the button that was clicked will be passed as the only parameter to the callback\n(could also be the top-right close button).", "sig" : "(title, msg, fn, scope)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "The title bar text", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The message box body text", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "(optional) The callback function invoked after the message box is closed", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the callback function", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.MessageBox", + "desc" : "This message box" + } + ] }, { "name" : "confirm", @@ -40012,7 +107501,49 @@ "desc" : "Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm).\nIf a callback function is passed it will be called after the user clicks either button, and the id of the\nbutton that was clicked will be passed as the only parameter to the callback (could also be the top-right close button).", "sig" : "(title, msg, fn, scope)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "The title bar text", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The message box body text", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "(optional) The callback function invoked after the message box is closed", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the callback function", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.MessageBox", + "desc" : "This message box" + } + ] }, { "name" : "getDialog", @@ -40020,7 +107551,24 @@ "desc" : "Returns a reference to the underlying {@link Roo.BasicDialog} element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.BasicDialog", + "desc" : "The BasicDialog element" + } + ] }, { "name" : "hide", @@ -40028,7 +107576,18 @@ "desc" : "Hides the message box if it is displayed", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -40036,7 +107595,24 @@ "desc" : "Returns true if the message box is currently displayed", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the message box is visible, else false" + } + ] }, { "name" : "progress", @@ -40044,7 +107620,37 @@ "desc" : "Displays a message box with a progress bar. This message box has no buttons and is not closeable by\nthe user. You are responsible for updating the progress bar as needed via {@link Roo.MessageBox#updateProgress}\nand closing the message box when the process is complete.", "sig" : "(title, msg)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "The title bar text", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The message box body text", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.MessageBox", + "desc" : "This message box" + } + ] }, { "name" : "prompt", @@ -40052,7 +107658,55 @@ "desc" : "Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to\nJavaScript's Window.prompt). The prompt can be a single-line or multi-line textbox. If a callback function\nis passed it will be called after the user clicks either button, and the id of the button that was clicked\n(could also be the top-right close button) and the text that was entered will be passed as the two\nparameters to the callback.", "sig" : "(title, msg, fn, scope, multiline)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "The title bar text", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The message box body text", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "(optional) The callback function invoked after the message box is closed", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the callback function", + "isOptional" : false + }, + { + "name" : "multiline", + "type" : "Boolean/Number", + "desc" : "(optional) True to create a multiline textbox using the defaultTextHeight\nproperty, or the height in pixels to create the textbox (defaults to false / single-line)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.MessageBox", + "desc" : "This message box" + } + ] }, { "name" : "show", @@ -40060,7 +107714,31 @@ "desc" : "Displays a new message box, or reinitializes an existing message box, based on the config options\npassed in. All functions (e.g. prompt, alert, etc) on MessageBox call this function internally.\nThe following config object properties are supported:\n
\nProperty    Type             Description\n----------  ---------------  ------------------------------------------------------------------------------------\nanimEl            String/Element   An id or Element from which the message box should animate as it opens and\n                                   closes (defaults to undefined)\nbuttons           Object/Boolean   A button config object (e.g., Roo.MessageBox.OKCANCEL or {ok:'Foo',\n                                   cancel:'Bar'}), or false to not show any buttons (defaults to false)\nclosable          Boolean          False to hide the top-right close button (defaults to true).  Note that\n                                   progress and wait dialogs will ignore this property and always hide the\n                                   close button as they can only be closed programmatically.\ncls               String           A custom CSS class to apply to the message box element\ndefaultTextHeight Number           The default height in pixels of the message box's multiline textarea if\n                                   displayed (defaults to 75)\nfn                Function         A callback function to execute after closing the dialog.  The arguments to the\n                                   function will be btn (the name of the button that was clicked, if applicable,\n                                   e.g. \"ok\"), and text (the value of the active text field, if applicable).\n                                   Progress and wait dialogs will ignore this option since they do not respond to\n                                   user actions and can only be closed programmatically, so any required function\n                                   should be called by the same code after it closes the dialog.\nicon              String           A CSS class that provides a background image to be used as an icon for\n                                   the dialog (e.g., Roo.MessageBox.WARNING or 'custom-class', defaults to '')\nmaxWidth          Number           The maximum width in pixels of the message box (defaults to 600)\nminWidth          Number           The minimum width in pixels of the message box (defaults to 100)\nmodal             Boolean          False to allow user interaction with the page while the message box is\n                                   displayed (defaults to true)\nmsg               String           A string that will replace the existing message box body text (defaults\n                                   to the XHTML-compliant non-breaking space character ' ')\nmultiline         Boolean          True to prompt the user to enter multi-line text (defaults to false)\nprogress          Boolean          True to display a progress bar (defaults to false)\nprogressText      String           The text to display inside the progress bar if progress = true (defaults to '')\nprompt            Boolean          True to prompt the user to enter single-line text (defaults to false)\nproxyDrag         Boolean          True to display a lightweight proxy while dragging (defaults to false)\ntitle             String           The title text\nvalue             String           The string value to set into the active textbox element if displayed\nwait              Boolean          True to display a progress bar (defaults to false)\nwidth             Number           The width of the dialog in pixels\n
\n\nExample usage:\n
\nRoo.Msg.show({\n   title: 'Address',\n   msg: 'Please enter your address:',\n   width: 300,\n   buttons: Roo.MessageBox.OKCANCEL,\n   multiline: true,\n   fn: saveAddress,\n   animEl: 'addAddressBtn'\n});\n
", "sig" : "(config)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "Configuration options", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.MessageBox", + "desc" : "This message box" + } + ] }, { "name" : "updateProgress", @@ -40068,7 +107746,37 @@ "desc" : "Updates a progress-style message box's text and progress bar. Only relevant on message boxes\ninitiated via {@link Roo.MessageBox#progress} or by calling {@link Roo.MessageBox#show} with progress: true.", "sig" : "(value, text)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Number", + "desc" : "Any number between 0 and 1 (e.g., .5)", + "isOptional" : false + }, + { + "name" : "text", + "type" : "String", + "desc" : "(optional) If defined, the message box's body text is replaced with the specified string (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.MessageBox", + "desc" : "This message box" + } + ] }, { "name" : "updateText", @@ -40076,7 +107784,31 @@ "desc" : "Updates the message box body text", "sig" : "(text)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "(optional) Replaces the message box element's innerHTML with the specified string (defaults to\nthe XHTML-compliant non-breaking space character ' ')", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.MessageBox", + "desc" : "This message box" + } + ] }, { "name" : "wait", @@ -40084,7 +107816,37 @@ "desc" : "Displays a message box with an infinitely auto-updating progress bar. This can be used to block user\ninteraction while waiting for a long-running process to complete that does not have defined intervals.\nYou are responsible for closing the message box when the process is complete.", "sig" : "(msg, title)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The message box body text", + "isOptional" : false + }, + { + "name" : "title", + "type" : "String", + "desc" : "(optional) The title bar text", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.MessageBox", + "desc" : "This message box" + } + ] } ] }, @@ -40124,12 +107886,7 @@ "name" : "buttonPosition", "type" : "String", "desc" : "r) default right (DEPRICATED) - use mr-auto on buttons to put them on the left", - "memberOf" : "", - "optvals" : [ - "left", - "right", - "center" - ] + "memberOf" : "" }, { "name" : "buttons", @@ -40189,11 +107946,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "html", @@ -40223,12 +107976,7 @@ "name" : "size", "type" : "String", "desc" : "l) default empty", - "memberOf" : "", - "optvals" : [ - "sm", - "lg", - "xl" - ] + "memberOf" : "" }, { "name" : "specificTitle", @@ -40264,11 +108012,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "width", @@ -40289,98 +108033,292 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "btnclick", "type" : "function", "desc" : "The raw btnclick event for the button", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fire when dialog resize", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Modal", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "titlechanged", "type" : "function", "desc" : "Fire when the editable title has been changed", "sig" : "function (_self, value)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Modal", + "desc" : "", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -40390,7 +108328,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -40398,7 +108354,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "applyBody", @@ -40406,7 +108398,25 @@ "desc" : "Set the body of the Dialog using the template", "sig" : "(data)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "data", + "type" : "Obj", + "desc" : "- apply this data to the template and replace the body contents.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "capture", @@ -40414,7 +108424,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -40422,7 +108462,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -40430,7 +108481,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -40438,7 +108506,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -40446,7 +108531,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -40454,7 +108569,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -40462,7 +108601,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -40470,7 +108626,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -40478,7 +108651,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -40486,7 +108676,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -40494,7 +108695,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -40502,7 +108727,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -40510,7 +108746,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -40518,7 +108765,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -40526,7 +108784,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -40534,7 +108828,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -40542,7 +108847,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -40550,7 +108873,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -40558,7 +108911,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setBody", @@ -40566,7 +108937,25 @@ "desc" : "Set the body of the Dialog", "sig" : "(str)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "str", + "type" : "String", + "desc" : "new Title", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDisabled", @@ -40574,7 +108963,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setTitle", @@ -40582,7 +108989,25 @@ "desc" : "Set the title of the Dialog", "sig" : "(str)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "str", + "type" : "String", + "desc" : "new Title", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -40590,7 +109015,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -40598,7 +109034,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -40606,7 +109066,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -40614,7 +109085,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -40622,7 +109110,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -40638,12 +109156,7 @@ "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "actionMode", @@ -40661,12 +109174,7 @@ "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allQuery", @@ -40720,11 +109228,7 @@ "name" : "append", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "autoCreate", @@ -40736,11 +109240,7 @@ "name" : "autoFocus", "type" : "Boolean", "desc" : "e) auto focus the first item, default true", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "autocomplete", @@ -40782,31 +109282,19 @@ "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "caret", "type" : "String", "desc" : "r) BS3 only - carat fa name", - "memberOf" : "Roo.bootstrap.TriggerField", - "optvals" : [ - "search", - "calendar" - ] + "memberOf" : "Roo.bootstrap.TriggerField" }, { "name" : "castInt", "type" : "Boolean", "desc" : "e) cast int if true (defalut true)", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "cls", @@ -40908,11 +109396,7 @@ "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "forceSelection", @@ -40948,11 +109432,7 @@ "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hiddenName", @@ -40964,11 +109444,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "hideTrigger", @@ -40980,11 +109456,7 @@ "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidClass", @@ -41008,11 +109480,7 @@ "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", @@ -41174,21 +109642,13 @@ "name" : "mobileTouchView", "type" : "Boolean", "desc" : "e) show mobile touch view when using a mobile default true", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "mobile_restrict_height", "type" : "Boolean", "desc" : "e) restrict height for touch view", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "modalTitle", @@ -41206,11 +109666,7 @@ "name" : "multiple", "type" : "Boolean", "desc" : "e) ComboBobArray, default false", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "name", @@ -41276,11 +109732,7 @@ "name" : "removable", "type" : "Boolean", "desc" : "e) special filter default false", - "memberOf" : "Roo.bootstrap.TriggerField", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.TriggerField" }, { "name" : "resizable", @@ -41328,11 +109780,7 @@ "name" : "specialFilter", "type" : "Boolean", "desc" : "e) special filter default false", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "store", @@ -41416,11 +109864,7 @@ "name" : "useNativeIOS", "type" : "Boolean", "desc" : "e) render it as classic select for ios, not support dynamic load data (default false)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "validClass", @@ -41480,11 +109924,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "vtype", @@ -41517,217 +109957,716 @@ "type" : "function", "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "Roo.bootstrap.ComboBox" + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "afterremove", "type" : "function", "desc" : "Fires when the remove value from the combobox array", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "Roo.bootstrap.ComboBox" + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforequery", "type" : "function", "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:", "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.ComboBox" + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "query", + "type" : "String", + "desc" : "The query", + "isOptional" : false + }, + { + "name" : "forceAll", + "type" : "Boolean", + "desc" : "true to force \"all\" query", + "isOptional" : false + }, + { + "name" : "cancel", + "type" : "Boolean", + "desc" : "true to cancel the query", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "The query event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeselect", "type" : "function", "desc" : "Fires before a list item is selected. Return false to cancel the selection.", "sig" : "function (combo, record, index)\n{\n\n}", - "memberOf" : "Roo.bootstrap.ComboBox" + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The data record returned from the underlying store", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the selected item in the dropdown list", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "childrenrendered", "type" : "function", "desc" : "Fires when the children have been rendered..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "collapse", "type" : "function", "desc" : "Fires when the dropdown list is collapsed", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "Roo.bootstrap.ComboBox" + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "edit", "type" : "function", "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)", "sig" : "function (combo, record)\n{\n\n}", - "memberOf" : "Roo.bootstrap.ComboBox" + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record|false", + "desc" : "The data record returned from the underlying store (or false on nothing selected)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enable", "type" : "function", "desc" : "Fires after the component is enabled.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "expand", "type" : "function", "desc" : "Fires when the dropdown list is expanded", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "Roo.bootstrap.ComboBox" + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "paste", "type" : "function", "desc" : "Fires after the user pastes into input", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "remove", "type" : "function", "desc" : "Fires when the remove value from the combobox array", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "Roo.bootstrap.ComboBox" + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "select", "type" : "function", "desc" : "Fires when a list item is selected", "sig" : "function (combo, record, index)\n{\n\n}", - "memberOf" : "Roo.bootstrap.ComboBox" + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The data record returned from the underlying store (or false on clear)", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the selected item in the dropdown list", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialfilter", "type" : "function", "desc" : "Fires when specialfilter", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "Roo.bootstrap.ComboBox" + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "tick", "type" : "function", "desc" : "Fires when tick the element", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "Roo.bootstrap.ComboBox" + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "touchviewdisplay", "type" : "function", "desc" : "Fires when touch view require special display (default is using displayField)", "sig" : "function (combo, cfg)\n{\n\n}", - "memberOf" : "Roo.bootstrap.ComboBox" + "memberOf" : "Roo.bootstrap.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.bootstrap.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "cfg", + "type" : "Object", + "desc" : "set html .", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -41737,7 +110676,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -41745,7 +110702,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "autoSize", @@ -41753,7 +110746,18 @@ "desc" : "", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.TriggerField" + "memberOf" : "Roo.bootstrap.TriggerField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -41761,7 +110765,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -41769,7 +110803,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "clearValue", @@ -41777,7 +110822,18 @@ "desc" : "Clears any text/value currently set in the field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.ComboBox" + "memberOf" : "Roo.bootstrap.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "collapse", @@ -41785,7 +110841,18 @@ "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.ComboBox" + "memberOf" : "Roo.bootstrap.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -41793,7 +110860,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -41801,7 +110879,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "doQuery", @@ -41809,7 +110904,31 @@ "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.", "sig" : "(query, forceAll)", "static" : false, - "memberOf" : "Roo.bootstrap.ComboBox" + "memberOf" : "Roo.bootstrap.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "query", + "type" : "String", + "desc" : "The SQL query to execute", + "isOptional" : false + }, + { + "name" : "forceAll", + "type" : "Boolean", + "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enable", @@ -41817,7 +110936,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "expand", @@ -41825,7 +110961,18 @@ "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.ComboBox" + "memberOf" : "Roo.bootstrap.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -41833,7 +110980,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -41841,7 +111018,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -41849,7 +111050,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -41857,7 +111075,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -41865,7 +111100,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -41873,7 +111125,24 @@ "desc" : "Returns the name of the field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] }, { "name" : "getRawValue", @@ -41881,7 +111150,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getValue", @@ -41889,7 +111175,24 @@ "desc" : "Returns the currently selected field value or empty string if no value is set.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.ComboBox" + "memberOf" : "Roo.bootstrap.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "value The selected value" + } + ] }, { "name" : "getVisibilityEl", @@ -41897,7 +111200,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -41905,7 +111219,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -41913,7 +111251,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -41921,7 +111270,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "inputEl", @@ -41929,7 +111289,18 @@ "desc" : "return the real input element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isExpanded", @@ -41937,7 +111308,18 @@ "desc" : "Returns true if the dropdown list is expanded, else false.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.ComboBox" + "memberOf" : "Roo.bootstrap.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -41945,7 +111327,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -41953,7 +111346,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "markValid", @@ -41961,7 +111372,18 @@ "desc" : "Mark this field as valid", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -41969,7 +111391,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onTriggerClick", @@ -41977,7 +111435,25 @@ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.bootstrap.TriggerField" + "memberOf" : "Roo.bootstrap.TriggerField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -41985,7 +111461,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -41993,7 +111480,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -42001,7 +111506,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -42009,7 +111544,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -42017,7 +111570,18 @@ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "select", @@ -42025,7 +111589,31 @@ "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", "sig" : "(index, scrollIntoView)", "static" : false, - "memberOf" : "Roo.bootstrap.ComboBox" + "memberOf" : "Roo.bootstrap.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The zero-based index of the list item to select", + "isOptional" : false + }, + { + "name" : "scrollIntoView", + "type" : "Boolean", + "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "selectByValue", @@ -42033,7 +111621,37 @@ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", "sig" : "(value, scrollIntoView)", "static" : false, - "memberOf" : "Roo.bootstrap.ComboBox" + "memberOf" : "Roo.bootstrap.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The data value of the item to select", + "isOptional" : false + }, + { + "name" : "scrollIntoView", + "type" : "Boolean", + "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value matched an item in the list, else false" + } + ] }, { "name" : "setDisabled", @@ -42041,7 +111659,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setEditable", @@ -42049,7 +111685,25 @@ "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.ComboBox" + "memberOf" : "Roo.bootstrap.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Boolean", + "desc" : "True to allow the user to directly edit the field text", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setFromData", @@ -42057,7 +111711,25 @@ "desc" : "Sets the value of the field based on a object which is related to the record format for the store.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.ComboBox" + "memberOf" : "Roo.bootstrap.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Object", + "desc" : "the value to set as. or false on reset?", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRawValue", @@ -42065,7 +111737,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setValue", @@ -42073,7 +111763,25 @@ "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.ComboBox" + "memberOf" : "Roo.bootstrap.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The value to match", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -42081,7 +111789,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -42089,7 +111808,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -42097,7 +111840,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -42105,7 +111859,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -42113,7 +111884,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "validate", @@ -42121,7 +111922,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -42129,7 +111947,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -42145,12 +111987,7 @@ "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "actionMode", @@ -42168,12 +112005,7 @@ "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", @@ -42215,11 +112047,7 @@ "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "cls", @@ -42273,41 +112101,25 @@ "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidClass", @@ -42331,11 +112143,7 @@ "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", @@ -42533,11 +112341,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "vtype", @@ -42564,140 +112368,454 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "childrenrendered", "type" : "function", "desc" : "Fires when the children have been rendered..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "paste", "type" : "function", "desc" : "Fires after the user pastes into input", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "select", "type" : "function", "desc" : "Fires when select a date.", "sig" : "function (_self, oldvalue, newvalue)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.MonthField", + "desc" : "", + "isOptional" : false + }, + { + "name" : "oldvalue", + "type" : "String", + "desc" : "The old value", + "isOptional" : false + }, + { + "name" : "newvalue", + "type" : "String", + "desc" : "The new value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires when this field show.", "sig" : "function (_self, date)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.MonthField", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Mixed", + "desc" : "The date value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -42707,7 +112825,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -42715,7 +112851,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -42723,7 +112895,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -42731,7 +112933,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -42739,7 +112952,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -42747,7 +112971,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -42755,7 +112996,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -42763,7 +113021,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -42771,7 +113059,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -42779,7 +113091,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -42787,7 +113116,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -42795,7 +113141,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -42803,7 +113166,24 @@ "desc" : "Returns the name of the field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] }, { "name" : "getRawValue", @@ -42811,7 +113191,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getValue", @@ -42819,7 +113216,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getVisibilityEl", @@ -42827,7 +113241,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -42835,7 +113260,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -42843,7 +113292,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -42851,7 +113311,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "inputEl", @@ -42859,7 +113330,18 @@ "desc" : "return the real input element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -42867,7 +113349,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -42875,7 +113368,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "markValid", @@ -42883,7 +113394,18 @@ "desc" : "Mark this field as valid", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -42891,7 +113413,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -42899,7 +113457,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -42907,7 +113476,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -42915,7 +113502,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -42923,7 +113540,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -42931,7 +113566,18 @@ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setDisabled", @@ -42939,7 +113585,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setRawValue", @@ -42947,7 +113611,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setValue", @@ -42955,7 +113637,25 @@ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -42963,7 +113663,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -42971,7 +113682,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -42979,7 +113714,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -42987,7 +113733,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -42995,7 +113758,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "validate", @@ -43003,7 +113796,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -43011,7 +113821,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -43027,11 +113861,7 @@ "name" : "align", "type" : "String", "desc" : "t)", - "memberOf" : "", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "" }, { "name" : "allowDomMove", @@ -43073,11 +113903,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "inverse", @@ -43125,22 +113951,13 @@ "name" : "type", "type" : "String", "desc" : "b) default nav", - "memberOf" : "", - "optvals" : [ - "nav", - "pills", - "tab" - ] + "memberOf" : "" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -43155,84 +113972,252 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "changed", "type" : "function", "desc" : "Fires when the active item changes", "sig" : "function (_self, selected, prev)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.NavGroup", + "desc" : "", + "isOptional" : false + }, + { + "name" : "selected", + "type" : "Roo.bootstrap.Navbar.Item", + "desc" : "The item selected", + "isOptional" : false + }, + { + "name" : "prev", + "type" : "Roo.bootstrap.Navbar.Item", + "desc" : "The previously selected item", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "childrenrendered", "type" : "function", "desc" : "Fires when the children have been rendered..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -43242,7 +114227,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addItem", @@ -43250,7 +114253,25 @@ "desc" : "adds a Navigation item", "sig" : "(the)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.NavItem", + "desc" : "navitem to add", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addListener", @@ -43258,7 +114279,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -43266,7 +114323,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearAll", @@ -43274,7 +114361,18 @@ "desc" : "clear all the Navigation item", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -43282,7 +114380,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -43290,7 +114399,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -43298,7 +114424,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -43306,7 +114449,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -43314,7 +114487,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "get", @@ -43322,7 +114519,25 @@ "desc" : "fetch a Navigation Group based on the navigation ID", "sig" : "(the)", "static" : true, - "memberOf" : "" + "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" : "getActive", @@ -43330,7 +114545,24 @@ "desc" : "gets the active Navigation item", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.bootstrap.NavItem", + "desc" : "the current navitem" + } + ] }, { "name" : "getChildContainer", @@ -43338,7 +114570,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -43346,7 +114595,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -43354,7 +114620,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -43362,7 +114645,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -43370,7 +114664,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -43378,7 +114696,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -43386,7 +114715,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -43394,7 +114734,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -43402,7 +114753,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -43410,7 +114797,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "register", @@ -43418,7 +114816,25 @@ "desc" : "register a Navigation item", "sig" : "(the)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.NavItem", + "desc" : "navitem to add", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "register", @@ -43426,7 +114842,25 @@ "desc" : "register a Navigation Group", "sig" : "(the)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.NavGroup", + "desc" : "navgroup to add", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "releaseCapture", @@ -43434,7 +114868,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -43442,7 +114894,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -43450,7 +114932,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setActiveItem", @@ -43458,7 +114958,25 @@ "desc" : "sets the active Navigation item", "sig" : "(the)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.NavItem", + "desc" : "new current navitem", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDisabled", @@ -43466,7 +114984,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -43474,7 +115010,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -43482,7 +115029,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -43490,7 +115061,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -43498,7 +115080,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -43506,7 +115105,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -43522,11 +115151,7 @@ "name" : "align", "type" : "String", "desc" : "t) alignment", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "allowDomMove", @@ -43598,11 +115223,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "inverse", @@ -43620,21 +115241,13 @@ "name" : "loadMask", "type" : "Boolean", "desc" : "e) loadMask on the bar", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "main", "type" : "Boolean", "desc" : "e) main nav bar? default false", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "mobilerow", @@ -43652,12 +115265,7 @@ "name" : "position", "type" : "String", "desc" : "p) position", - "memberOf" : "", - "optvals" : [ - "fixed-top", - "fixed-bottom", - "static-top" - ] + "memberOf" : "" }, { "name" : "srButton", @@ -43675,13 +115283,7 @@ "name" : "tag", "type" : "String", "desc" : "v) default is nav", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "header", - "footer", - "nav", - "div" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "tooltip", @@ -43693,39 +115295,19 @@ "name" : "type", "type" : "String", "desc" : "s)", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "nav", - "pills", - "tabs" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "weight", "type" : "String", "desc" : "e) default is light.", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "light", - "primary", - "secondary", - "success", - "danger", - "warning", - "info", - "dark", - "white" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "xattr", @@ -43740,84 +115322,240 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforetoggle", "type" : "function", "desc" : "Fire before toggle the menu", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Navbar" + "memberOf" : "Roo.bootstrap.Navbar", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -43827,7 +115565,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -43835,7 +115591,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -43843,7 +115635,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "collapse", @@ -43851,7 +115673,18 @@ "desc" : "Collapse the navbar pulldown", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Navbar" + "memberOf" : "Roo.bootstrap.Navbar", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -43859,7 +115692,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -43867,7 +115711,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -43875,7 +115736,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "expand", @@ -43883,7 +115761,18 @@ "desc" : "Expand the navbar pulldown", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Navbar" + "memberOf" : "Roo.bootstrap.Navbar", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -43891,7 +115780,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -43899,7 +115818,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -43907,7 +115850,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -43915,7 +115875,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -43923,7 +115900,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -43931,7 +115925,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -43939,7 +115944,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -43947,7 +115976,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -43955,7 +115995,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -43963,7 +116014,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -43971,7 +116033,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -43979,7 +116077,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -43987,7 +116096,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -43995,7 +116122,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -44003,7 +116160,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -44011,7 +116186,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -44019,7 +116212,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -44027,7 +116231,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -44035,7 +116263,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -44043,7 +116282,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -44051,7 +116307,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -44079,11 +116365,7 @@ "name" : "animateRef", "type" : "Boolean", "desc" : "e) link to element default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "badge", @@ -44095,12 +116377,7 @@ "name" : "badgecls", "type" : "String", "desc" : "w)the extra classes for the badge", - "memberOf" : "", - "optvals" : [ - "bg-green", - "bg-red", - "bg-yellow" - ] + "memberOf" : "" }, { "name" : "button_outline", @@ -44112,19 +116389,7 @@ "name" : "button_weight", "type" : "String", "desc" : "k) default none", - "memberOf" : "", - "optvals" : [ - "default", - "primary", - "secondary", - "success", - "info", - "warning", - "danger", - "link", - "light", - "dark" - ] + "memberOf" : "" }, { "name" : "can_build_overlaid", @@ -44178,11 +116443,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "href", @@ -44224,11 +116485,7 @@ "name" : "preventDefault", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "style", @@ -44246,11 +116503,7 @@ "name" : "tagtype", "type" : "String", "desc" : "n) render as a href or span?", - "memberOf" : "", - "optvals" : [ - "a", - "span" - ] + "memberOf" : "" }, { "name" : "tooltip", @@ -44262,11 +116515,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -44281,98 +116530,298 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.NavItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "state", + "type" : "boolean", + "desc" : "the new state", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "childrenrendered", "type" : "function", "desc" : "Fires when the children have been rendered..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "The raw click event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "scrollto", "type" : "function", "desc" : "Fires when scroll to element", "sig" : "function (_self, options, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.NavItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -44382,7 +116831,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -44390,7 +116857,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -44398,7 +116901,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -44406,7 +116939,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -44414,7 +116958,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -44422,7 +116983,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -44430,7 +117008,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -44438,7 +117046,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -44446,7 +117078,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -44454,7 +117103,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -44462,7 +117128,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -44470,7 +117153,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -44478,7 +117172,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -44486,7 +117204,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -44494,7 +117223,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -44502,7 +117242,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -44510,7 +117261,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -44518,7 +117305,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -44526,7 +117324,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -44534,7 +117350,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -44542,7 +117388,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -44550,7 +117414,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setHtml", @@ -44558,7 +117440,25 @@ "desc" : "Set the HTML (text content) of the item", "sig" : "(html)", "static" : false, - "memberOf" : "" + "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" : "setVisibilityEl", @@ -44566,7 +117466,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -44574,7 +117485,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -44582,7 +117517,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -44590,7 +117536,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "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" : "un", @@ -44598,7 +117561,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -44650,11 +117643,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -44684,11 +117673,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -44703,84 +117688,252 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "changed", "type" : "function", "desc" : "Fires when the active item changes", "sig" : "function (_self, selected, prev)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.NavProgressBar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "selected", + "type" : "Roo.bootstrap.NavProgressItem", + "desc" : "The item selected", + "isOptional" : false + }, + { + "name" : "prev", + "type" : "Roo.bootstrap.NavProgressItem", + "desc" : "The previously selected item", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "childrenrendered", "type" : "function", "desc" : "Fires when the children have been rendered..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -44790,7 +117943,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -44798,7 +117969,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -44806,7 +118013,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -44814,7 +118051,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -44822,7 +118070,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -44830,7 +118095,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -44838,7 +118120,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -44846,7 +118158,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -44854,7 +118190,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -44862,7 +118215,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -44870,7 +118240,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -44878,7 +118265,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -44886,7 +118284,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -44894,7 +118316,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -44902,7 +118335,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -44910,7 +118354,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -44918,7 +118373,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -44926,7 +118417,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -44934,7 +118436,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -44942,7 +118462,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -44950,7 +118500,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -44958,7 +118526,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -44966,7 +118552,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -44974,7 +118571,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -44982,7 +118603,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -44990,7 +118622,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -44998,7 +118647,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -45014,11 +118693,7 @@ "name" : "active", "type" : "Boolean", "desc" : "e) Is item active default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "allowDomMove", @@ -45060,21 +118735,13 @@ "name" : "disabled", "type" : "Boolean", "desc" : "e) Is item active default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "html", @@ -45104,11 +118771,7 @@ "name" : "position", "type" : "String", "desc" : "m) text position default bottom", - "memberOf" : "", - "optvals" : [ - "top", - "bottom" - ] + "memberOf" : "" }, { "name" : "rid", @@ -45132,11 +118795,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -45151,84 +118810,246 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "The raw click event for the entire grid.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.NavProgressItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -45238,7 +119059,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -45246,7 +119085,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -45254,7 +119129,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -45262,7 +119167,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -45270,7 +119186,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -45278,7 +119211,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -45286,7 +119236,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -45294,7 +119274,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -45302,7 +119306,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -45310,7 +119331,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -45318,7 +119356,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -45326,7 +119381,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -45334,7 +119400,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -45342,7 +119432,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -45350,7 +119451,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -45358,7 +119470,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -45366,7 +119489,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -45374,7 +119533,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -45382,7 +119552,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -45390,7 +119578,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -45398,7 +119616,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -45406,7 +119642,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -45414,7 +119668,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -45422,7 +119687,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -45430,7 +119719,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -45438,7 +119738,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -45446,7 +119763,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -45498,11 +119845,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -45532,11 +119875,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -45551,84 +119890,240 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforetoggle", "type" : "function", "desc" : "Fire before toggle the menu", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Navbar" + "memberOf" : "Roo.bootstrap.Navbar", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -45638,7 +120133,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -45646,7 +120159,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -45654,7 +120203,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "collapse", @@ -45662,7 +120241,18 @@ "desc" : "Collapse the navbar pulldown", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Navbar" + "memberOf" : "Roo.bootstrap.Navbar", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -45670,7 +120260,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -45678,7 +120279,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -45686,7 +120304,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "expand", @@ -45694,7 +120329,18 @@ "desc" : "Expand the navbar pulldown", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Navbar" + "memberOf" : "Roo.bootstrap.Navbar", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -45702,7 +120348,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -45710,7 +120386,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -45718,7 +120418,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -45726,7 +120443,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -45734,7 +120468,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -45742,7 +120493,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -45750,7 +120512,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -45758,7 +120544,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -45766,7 +120563,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -45774,7 +120582,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -45782,7 +120601,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -45790,7 +120645,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -45798,7 +120664,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -45806,7 +120690,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -45814,7 +120728,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -45822,7 +120754,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -45830,7 +120780,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -45838,7 +120799,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -45846,7 +120831,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -45854,7 +120850,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -45862,7 +120875,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -45890,11 +120933,7 @@ "name" : "animateRef", "type" : "Boolean", "desc" : "e) link to element default false", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.NavItem" }, { "name" : "badge", @@ -45906,12 +120945,7 @@ "name" : "badgecls", "type" : "String", "desc" : "w)the extra classes for the badge", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [ - "bg-green", - "bg-red", - "bg-yellow" - ] + "memberOf" : "Roo.bootstrap.NavItem" }, { "name" : "button_outline", @@ -45923,19 +120957,7 @@ "name" : "button_weight", "type" : "String", "desc" : "k) default none", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [ - "default", - "primary", - "secondary", - "success", - "info", - "warning", - "danger", - "link", - "light", - "dark" - ] + "memberOf" : "Roo.bootstrap.NavItem" }, { "name" : "can_build_overlaid", @@ -45989,11 +121011,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "href", @@ -46035,11 +121053,7 @@ "name" : "preventDefault", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.NavItem" }, { "name" : "style", @@ -46057,11 +121071,7 @@ "name" : "tagtype", "type" : "String", "desc" : "n) render as a href or span?", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [ - "a", - "span" - ] + "memberOf" : "Roo.bootstrap.NavItem" }, { "name" : "tooltip", @@ -46073,11 +121083,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -46092,98 +121098,298 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.NavSidebarItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "state", + "type" : "boolean", + "desc" : "the new state", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "childrenrendered", "type" : "function", "desc" : "Fires when the children have been rendered..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "The raw click event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "scrollto", "type" : "function", "desc" : "Fires when scroll to element", "sig" : "function (_self, options, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.NavItem" + "memberOf" : "Roo.bootstrap.NavItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.NavItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -46193,7 +121399,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -46201,7 +121425,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -46209,7 +121469,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -46217,7 +121507,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -46225,7 +121526,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -46233,7 +121551,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -46241,7 +121576,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -46249,7 +121614,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -46257,7 +121646,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -46265,7 +121671,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -46273,7 +121696,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -46281,7 +121721,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -46289,7 +121740,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -46297,7 +121772,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -46305,7 +121791,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -46313,7 +121810,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -46321,7 +121829,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -46329,7 +121873,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -46337,7 +121892,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -46345,7 +121918,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -46353,7 +121956,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -46361,7 +121982,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setHtml", @@ -46369,7 +122008,25 @@ "desc" : "Set the HTML (text content) of the item", "sig" : "(html)", "static" : false, - "memberOf" : "Roo.bootstrap.NavItem" + "memberOf" : "Roo.bootstrap.NavItem", + "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" : "setVisibilityEl", @@ -46377,7 +122034,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -46385,7 +122053,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -46393,7 +122085,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -46401,7 +122104,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.NavItem" + "memberOf" : "Roo.bootstrap.NavItem", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "defaults to this.el" + } + ] }, { "name" : "un", @@ -46409,7 +122129,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -46425,11 +122175,7 @@ "name" : "align", "type" : "String", "desc" : "t) alignment", - "memberOf" : "", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "" }, { "name" : "allowDomMove", @@ -46477,11 +122223,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "inverse", @@ -46499,21 +122241,13 @@ "name" : "loadMask", "type" : "Boolean", "desc" : "e) loadMask on the bar", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "main", "type" : "Boolean", "desc" : "e) main nav bar? default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "name", @@ -46531,13 +122265,7 @@ "name" : "tag", "type" : "String", "desc" : "v) default is nav", - "memberOf" : "", - "optvals" : [ - "header", - "footer", - "nav", - "div" - ] + "memberOf" : "" }, { "name" : "tooltip", @@ -46549,39 +122277,19 @@ "name" : "type", "type" : "String", "desc" : "s)", - "memberOf" : "", - "optvals" : [ - "nav", - "pills", - "tabs" - ] + "memberOf" : "" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "weight", "type" : "String", "desc" : "e) default is light.", - "memberOf" : "", - "optvals" : [ - "light", - "primary", - "secondary", - "success", - "danger", - "warning", - "info", - "dark", - "white" - ] + "memberOf" : "" }, { "name" : "xattr", @@ -46596,84 +122304,240 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforetoggle", "type" : "function", "desc" : "Fire before toggle the menu", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Navbar" + "memberOf" : "Roo.bootstrap.Navbar", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -46683,7 +122547,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -46691,7 +122573,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -46699,7 +122617,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "collapse", @@ -46707,7 +122655,18 @@ "desc" : "Collapse the navbar pulldown", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Navbar" + "memberOf" : "Roo.bootstrap.Navbar", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -46715,7 +122674,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -46723,7 +122693,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -46731,7 +122718,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "expand", @@ -46739,7 +122743,18 @@ "desc" : "Expand the navbar pulldown", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Navbar" + "memberOf" : "Roo.bootstrap.Navbar", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -46747,7 +122762,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -46755,7 +122800,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -46763,7 +122832,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -46771,7 +122857,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -46779,7 +122882,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -46787,7 +122907,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -46795,7 +122926,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -46803,7 +122958,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -46811,7 +122977,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -46819,7 +122996,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -46827,7 +123015,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -46835,7 +123059,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -46843,7 +123078,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -46851,7 +123104,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -46859,7 +123142,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -46867,7 +123168,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -46875,7 +123194,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -46883,7 +123213,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -46891,7 +123245,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -46899,7 +123264,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -46907,7 +123289,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -46959,11 +123371,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -46993,11 +123401,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -47012,84 +123416,240 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforetoggle", "type" : "function", "desc" : "Fire before toggle the menu", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -47099,7 +123659,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -47107,7 +123685,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -47115,7 +123729,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "collapse", @@ -47123,7 +123767,18 @@ "desc" : "Collapse the navbar pulldown", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -47131,7 +123786,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -47139,7 +123805,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -47147,7 +123830,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "expand", @@ -47155,7 +123855,18 @@ "desc" : "Expand the navbar pulldown", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -47163,7 +123874,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -47171,7 +123912,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -47179,7 +123944,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -47187,7 +123969,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -47195,7 +123994,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -47203,7 +124019,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -47211,7 +124038,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -47219,7 +124070,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -47227,7 +124089,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -47235,7 +124108,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -47243,7 +124127,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -47251,7 +124171,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -47259,7 +124190,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -47267,7 +124216,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -47275,7 +124254,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -47283,7 +124280,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -47291,7 +124306,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -47299,7 +124325,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -47307,7 +124357,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -47315,7 +124376,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -47323,7 +124401,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -47339,12 +124447,7 @@ "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "actionMode", @@ -47362,12 +124465,7 @@ "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", @@ -47427,11 +124525,7 @@ "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "cls", @@ -47497,41 +124591,25 @@ "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidClass", @@ -47555,11 +124633,7 @@ "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", @@ -47793,11 +124867,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "vtype", @@ -47824,133 +124894,416 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "childrenrendered", "type" : "function", "desc" : "Fires when the children have been rendered..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "paste", "type" : "function", "desc" : "Fires after the user pastes into input", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -47960,7 +125313,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -47968,7 +125339,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -47976,7 +125383,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -47984,7 +125421,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -47992,7 +125440,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -48000,7 +125459,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -48008,7 +125484,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -48016,7 +125509,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -48024,7 +125547,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -48032,7 +125579,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -48040,7 +125604,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -48048,7 +125629,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -48056,7 +125654,24 @@ "desc" : "Returns the name of the field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] }, { "name" : "getRawValue", @@ -48064,7 +125679,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getValue", @@ -48072,7 +125704,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getVisibilityEl", @@ -48080,7 +125729,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -48088,7 +125748,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -48096,7 +125780,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -48104,7 +125799,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "inputEl", @@ -48112,7 +125818,18 @@ "desc" : "return the real input element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -48120,7 +125837,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -48128,7 +125856,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "markValid", @@ -48136,7 +125882,18 @@ "desc" : "Mark this field as valid", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -48144,7 +125901,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -48152,7 +125945,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -48160,7 +125964,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -48168,7 +125990,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -48176,7 +126028,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -48184,7 +126054,18 @@ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setDisabled", @@ -48192,7 +126073,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setRawValue", @@ -48200,7 +126099,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setValue", @@ -48208,7 +126125,25 @@ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -48216,7 +126151,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -48224,7 +126170,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -48232,7 +126202,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -48240,7 +126221,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -48248,7 +126246,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "validate", @@ -48256,7 +126284,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -48264,7 +126309,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -48316,11 +126385,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "inverse", @@ -48362,11 +126427,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -48381,77 +126442,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -48461,7 +126665,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -48469,7 +126691,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -48477,7 +126735,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -48485,7 +126773,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -48493,7 +126792,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -48501,7 +126817,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -48509,7 +126842,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -48517,7 +126880,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -48525,7 +126912,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -48533,7 +126937,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -48541,7 +126962,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -48549,7 +126987,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -48557,7 +127006,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -48565,7 +127038,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -48573,7 +127057,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -48581,7 +127076,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -48589,7 +127095,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -48597,7 +127139,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -48605,7 +127158,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -48613,7 +127184,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -48621,7 +127222,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -48629,7 +127248,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -48637,7 +127274,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -48645,7 +127293,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -48653,7 +127325,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -48661,7 +127344,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -48669,7 +127369,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -48685,11 +127415,7 @@ "name" : "active", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "allowDomMove", @@ -48737,11 +127463,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "href", @@ -48771,11 +127493,7 @@ "name" : "preventDefault", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "style", @@ -48793,11 +127511,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -48812,84 +127526,240 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "The raw click event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -48899,7 +127769,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -48907,7 +127795,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -48915,7 +127839,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -48923,7 +127877,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -48931,7 +127896,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -48939,7 +127921,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -48947,7 +127946,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -48955,7 +127984,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -48963,7 +128016,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -48971,7 +128041,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -48979,7 +128066,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -48987,7 +128091,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -48995,7 +128110,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -49003,7 +128142,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -49011,7 +128161,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -49019,7 +128180,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -49027,7 +128199,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -49035,7 +128243,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -49043,7 +128262,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -49051,7 +128288,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -49059,7 +128326,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -49067,7 +128352,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -49075,7 +128378,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -49083,7 +128397,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -49091,7 +128429,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -49099,7 +128448,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -49107,7 +128473,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -49123,11 +128519,7 @@ "name" : "align", "type" : "String", "desc" : "t) alignment", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "allowDomMove", @@ -49205,11 +128597,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "inverse", @@ -49227,21 +128615,13 @@ "name" : "loadMask", "type" : "Boolean", "desc" : "e) loadMask on the bar", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "main", "type" : "Boolean", "desc" : "e) main nav bar? default false", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "name", @@ -49265,13 +128645,7 @@ "name" : "tag", "type" : "String", "desc" : "v) default is nav", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "header", - "footer", - "nav", - "div" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "tooltip", @@ -49283,39 +128657,19 @@ "name" : "type", "type" : "String", "desc" : "s)", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "nav", - "pills", - "tabs" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "weight", "type" : "String", "desc" : "e) default is light.", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "light", - "primary", - "secondary", - "success", - "danger", - "warning", - "info", - "dark", - "white" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "xattr", @@ -49330,84 +128684,240 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforetoggle", "type" : "function", "desc" : "Fire before toggle the menu", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Navbar" + "memberOf" : "Roo.bootstrap.Navbar", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -49417,7 +128927,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -49425,7 +128953,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "bind", @@ -49433,7 +128997,25 @@ "desc" : "Binds the paging toolbar to the specified {@link Roo.data.Store}", "sig" : "(store)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "store", + "type" : "Roo.data.Store", + "desc" : "The data store to bind", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "capture", @@ -49441,7 +129023,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "collapse", @@ -49449,7 +129061,18 @@ "desc" : "Collapse the navbar pulldown", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Navbar" + "memberOf" : "Roo.bootstrap.Navbar", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -49457,7 +129080,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -49465,7 +129099,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -49473,7 +129124,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "expand", @@ -49481,7 +129149,18 @@ "desc" : "Expand the navbar pulldown", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Navbar" + "memberOf" : "Roo.bootstrap.Navbar", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -49489,7 +129168,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -49497,7 +129206,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -49505,7 +129238,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -49513,7 +129263,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -49521,7 +129288,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -49529,7 +129313,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -49537,7 +129332,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -49545,7 +129364,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -49553,7 +129383,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -49561,7 +129402,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -49569,7 +129421,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -49577,7 +129465,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -49585,7 +129484,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -49593,7 +129510,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -49601,7 +129548,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -49609,7 +129574,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -49617,7 +129600,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -49625,7 +129619,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -49633,7 +129651,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -49641,7 +129670,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -49649,7 +129695,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "unbind", @@ -49657,7 +129733,25 @@ "desc" : "Unbinds the paging toolbar from the specified {@link Roo.data.Store}", "sig" : "(store)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "store", + "type" : "Roo.data.Store", + "desc" : "The data store to unbind", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -49673,12 +129767,7 @@ "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "actionMode", @@ -49696,12 +129785,7 @@ "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", @@ -49743,21 +129827,13 @@ "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "caret", "type" : "String", "desc" : "r) BS3 only - carat fa name", - "memberOf" : "Roo.bootstrap.TriggerField", - "optvals" : [ - "search", - "calendar" - ] + "memberOf" : "Roo.bootstrap.TriggerField" }, { "name" : "cls", @@ -49817,31 +129893,19 @@ "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "hideTrigger", @@ -49853,11 +129917,7 @@ "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidClass", @@ -49881,11 +129941,7 @@ "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", @@ -50011,11 +130067,7 @@ "name" : "removable", "type" : "Boolean", "desc" : "e) special filter default false", - "memberOf" : "Roo.bootstrap.TriggerField", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.TriggerField" }, { "name" : "selectOnFocus", @@ -50035,6 +130087,12 @@ "desc" : "colspan out of 12 for tablet-sized screens", "memberOf" : "Roo.bootstrap.Input" }, + { + "name" : "store", + "type" : "Roo.data.Store", + "desc" : "[required] The data store to which this combo is bound (defaults to undefined)", + "memberOf" : "" + }, { "name" : "style", "type" : "String", @@ -50099,11 +130157,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "vtype", @@ -50130,133 +130184,416 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "childrenrendered", "type" : "function", "desc" : "Fires when the children have been rendered..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "paste", "type" : "function", "desc" : "Fires after the user pastes into input", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -50266,7 +130603,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -50274,7 +130629,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "autoSize", @@ -50282,7 +130673,18 @@ "desc" : "", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.TriggerField" + "memberOf" : "Roo.bootstrap.TriggerField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -50290,7 +130692,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -50298,7 +130730,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -50306,7 +130749,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -50314,7 +130768,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -50322,7 +130793,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -50330,7 +130818,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -50338,7 +130856,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -50346,7 +130888,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -50354,7 +130913,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -50362,7 +130938,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -50370,7 +130963,24 @@ "desc" : "Returns the name of the field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] }, { "name" : "getRawValue", @@ -50378,7 +130988,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getValue", @@ -50386,7 +131013,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getVisibilityEl", @@ -50394,7 +131038,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -50402,7 +131057,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -50410,7 +131089,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -50418,7 +131108,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "inputEl", @@ -50426,7 +131127,18 @@ "desc" : "return the real input element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -50434,7 +131146,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -50442,7 +131165,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "markValid", @@ -50450,7 +131191,18 @@ "desc" : "Mark this field as valid", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -50458,7 +131210,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onTriggerClick", @@ -50466,7 +131254,25 @@ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.bootstrap.TriggerField" + "memberOf" : "Roo.bootstrap.TriggerField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -50474,7 +131280,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -50482,7 +131299,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -50490,7 +131325,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -50498,7 +131363,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -50506,7 +131389,18 @@ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setDisabled", @@ -50514,7 +131408,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setRawValue", @@ -50522,7 +131434,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setValue", @@ -50530,7 +131460,25 @@ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -50538,7 +131486,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -50546,7 +131505,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -50554,7 +131537,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -50562,7 +131556,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -50570,7 +131581,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "validate", @@ -50578,7 +131619,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -50586,7 +131644,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -50656,11 +131738,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "html", @@ -50714,11 +131792,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -50733,77 +131807,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "After the popover hide", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Popover", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "After the popover show", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Popover", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -50813,7 +132030,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -50821,7 +132056,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -50829,7 +132100,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -50837,7 +132138,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -50845,7 +132157,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -50853,7 +132182,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -50861,7 +132207,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -50869,7 +132245,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -50877,7 +132277,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -50885,7 +132302,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -50893,7 +132327,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -50901,7 +132352,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -50909,7 +132371,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -50917,7 +132403,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -50925,7 +132422,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -50933,7 +132441,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -50941,7 +132460,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -50949,7 +132504,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -50957,7 +132523,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -50965,7 +132549,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -50973,7 +132587,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setContent", @@ -50981,7 +132613,25 @@ "desc" : "", "sig" : "(the)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "string", + "desc" : "body content", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDisabled", @@ -50989,7 +132639,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setTitle", @@ -50997,7 +132665,25 @@ "desc" : "", "sig" : "(the)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "string", + "desc" : "title", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -51005,7 +132691,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -51013,7 +132710,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -51021,7 +132742,31 @@ "desc" : "Show the popover", "sig" : "(-, (left|right|top|bottom))", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "-", + "type" : "Roo.Element|string|Boolean", + "desc" : "element to align and point to. (set align to [ pos, offset ])", + "isOptional" : false + }, + { + "name" : "(left|right|top|bottom)", + "type" : "string", + "desc" : "position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "tooltipEl", @@ -51029,7 +132774,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -51037,7 +132799,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updatePosition", @@ -51045,7 +132837,31 @@ "desc" : "fire this manually after loading a grid in the table for example", "sig" : "((left|right|top|bottom), try)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "(left|right|top|bottom)", + "type" : "string", + "desc" : "where to try and put it (use false to use the last one)", + "isOptional" : false + }, + { + "name" : "try", + "type" : "Boolean", + "desc" : "and move it if we cant get right position.", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -51061,11 +132877,7 @@ "name" : "align", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.NavGroup", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.NavGroup" }, { "name" : "allowDomMove", @@ -51107,11 +132919,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "inverse", @@ -51159,22 +132967,13 @@ "name" : "type", "type" : "String", "desc" : "b) default nav", - "memberOf" : "Roo.bootstrap.NavGroup", - "optvals" : [ - "nav", - "pills", - "tab" - ] + "memberOf" : "Roo.bootstrap.NavGroup" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -51189,84 +132988,252 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "changed", "type" : "function", "desc" : "Fires when the active item changes", "sig" : "function (_self, selected, prev)\n{\n\n}", - "memberOf" : "Roo.bootstrap.NavGroup" + "memberOf" : "Roo.bootstrap.NavGroup", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.NavGroup", + "desc" : "", + "isOptional" : false + }, + { + "name" : "selected", + "type" : "Roo.bootstrap.Navbar.Item", + "desc" : "The item selected", + "isOptional" : false + }, + { + "name" : "prev", + "type" : "Roo.bootstrap.Navbar.Item", + "desc" : "The previously selected item", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "childrenrendered", "type" : "function", "desc" : "Fires when the children have been rendered..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -51276,7 +133243,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addItem", @@ -51284,7 +133269,25 @@ "desc" : "adds a Navigation item", "sig" : "(the)", "static" : false, - "memberOf" : "Roo.bootstrap.NavGroup" + "memberOf" : "Roo.bootstrap.NavGroup", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.NavItem", + "desc" : "navitem to add", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addListener", @@ -51292,7 +133295,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -51300,7 +133339,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearAll", @@ -51308,7 +133377,18 @@ "desc" : "clear all the Navigation item", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.NavGroup" + "memberOf" : "Roo.bootstrap.NavGroup", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -51316,7 +133396,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -51324,7 +133415,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -51332,7 +133440,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -51340,7 +133465,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -51348,7 +133503,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "get", @@ -51356,7 +133535,25 @@ "desc" : "fetch a Navigation Group based on the navigation ID", "sig" : "(the)", "static" : true, - "memberOf" : "Roo.bootstrap.NavGroup" + "memberOf" : "Roo.bootstrap.NavGroup", + "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" : "getActive", @@ -51364,7 +133561,24 @@ "desc" : "gets the active Navigation item", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.NavGroup" + "memberOf" : "Roo.bootstrap.NavGroup", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.bootstrap.NavItem", + "desc" : "the current navitem" + } + ] }, { "name" : "getChildContainer", @@ -51372,7 +133586,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -51380,7 +133611,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -51388,7 +133636,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -51396,7 +133661,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -51404,7 +133680,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -51412,7 +133712,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -51420,7 +133731,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -51428,7 +133750,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -51436,7 +133769,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -51444,7 +133813,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "register", @@ -51452,7 +133832,25 @@ "desc" : "register a Navigation item", "sig" : "(the)", "static" : false, - "memberOf" : "Roo.bootstrap.NavGroup" + "memberOf" : "Roo.bootstrap.NavGroup", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.NavItem", + "desc" : "navitem to add", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "releaseCapture", @@ -51460,7 +133858,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -51468,7 +133884,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -51476,7 +133922,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setActiveItem", @@ -51484,7 +133948,25 @@ "desc" : "sets the active Navigation item", "sig" : "(the)", "static" : false, - "memberOf" : "Roo.bootstrap.NavGroup" + "memberOf" : "Roo.bootstrap.NavGroup", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.NavItem", + "desc" : "new current navitem", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDisabled", @@ -51492,7 +133974,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -51500,7 +134000,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -51508,7 +134019,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -51516,7 +134051,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -51524,7 +134070,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -51532,7 +134095,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -51590,11 +134183,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -51630,11 +134219,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -51649,77 +134234,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -51729,7 +134457,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -51737,7 +134483,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -51745,7 +134527,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -51753,7 +134565,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -51761,7 +134584,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -51769,7 +134609,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -51777,7 +134634,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -51785,7 +134672,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -51793,7 +134704,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -51801,7 +134729,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -51809,7 +134754,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -51817,7 +134779,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -51825,7 +134798,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -51833,7 +134830,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -51841,7 +134849,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -51849,7 +134868,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -51857,7 +134887,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -51865,7 +134931,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -51873,7 +134950,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -51881,7 +134976,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -51889,7 +135014,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -51897,7 +135040,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -51905,7 +135066,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -51913,7 +135085,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -51921,7 +135117,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -51929,7 +135136,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -51937,7 +135161,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -52007,11 +135261,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "label", @@ -52035,13 +135285,7 @@ "name" : "panel", "type" : "String", "desc" : ")", - "memberOf" : "", - "optvals" : [ - "success", - "info", - "warning", - "danger" - ] + "memberOf" : "" }, { "name" : "role", @@ -52071,11 +135315,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -52090,77 +135330,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -52170,7 +135553,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -52178,7 +135579,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -52186,7 +135623,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -52194,7 +135661,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -52202,7 +135680,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -52210,7 +135705,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -52218,7 +135730,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -52226,7 +135768,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -52234,7 +135800,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -52242,7 +135825,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -52250,7 +135850,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -52258,7 +135875,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -52266,7 +135894,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -52274,7 +135926,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -52282,7 +135945,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -52290,7 +135964,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -52298,7 +135983,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -52306,7 +136027,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -52314,7 +136046,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -52322,7 +136072,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -52330,7 +136110,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -52338,7 +136136,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -52346,7 +136162,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -52354,7 +136181,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -52362,7 +136213,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -52370,7 +136232,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -52378,7 +136257,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -52436,11 +136345,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -52476,11 +136381,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -52495,77 +136396,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -52575,7 +136619,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -52583,7 +136645,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -52591,7 +136689,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -52599,7 +136727,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -52607,7 +136746,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -52615,7 +136771,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -52623,7 +136796,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -52631,7 +136834,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -52639,7 +136866,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -52647,7 +136891,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -52655,7 +136916,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -52663,7 +136941,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -52671,7 +136960,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -52679,7 +136992,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -52687,7 +137011,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -52695,7 +137030,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -52703,7 +137049,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -52711,7 +137093,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -52719,7 +137112,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -52727,7 +137138,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -52735,7 +137176,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -52743,7 +137202,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -52751,7 +137228,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -52759,7 +137247,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -52767,7 +137279,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -52775,7 +137298,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -52783,7 +137323,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -52799,12 +137369,7 @@ "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "actionMode", @@ -52822,12 +137387,7 @@ "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", @@ -52869,11 +137429,7 @@ "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "cls", @@ -52927,51 +137483,31 @@ "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "" }, { "name" : "inline", "type" : "Boolean", "desc" : "e) inline the element (default true)", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "invalidClass", @@ -52995,11 +137531,7 @@ "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", @@ -53191,11 +137723,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "vtype", @@ -53207,14 +137735,7 @@ "name" : "weight", "type" : "String", "desc" : "s) The text that appears beside the radio", - "memberOf" : "", - "optvals" : [ - "primary", - "warning", - "info", - "danger", - "success" - ] + "memberOf" : "" }, { "name" : "xattr", @@ -53235,147 +137756,474 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "check", "type" : "function", "desc" : "Fires when the element is checked or unchecked.", "sig" : "function (_self, item)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.RadioSet", + "desc" : "This radio", + "isOptional" : false + }, + { + "name" : "item", + "type" : "Roo.bootstrap.Radio", + "desc" : "The checked item", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "childrenrendered", "type" : "function", "desc" : "Fires when the children have been rendered..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fires when the element is click.", "sig" : "function (_self, item, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.RadioSet", + "desc" : "This radio set", + "isOptional" : false + }, + { + "name" : "item", + "type" : "Roo.bootstrap.Radio", + "desc" : "The checked item", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "paste", "type" : "function", "desc" : "Fires after the user pastes into input", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -53385,7 +138233,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -53393,7 +138259,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -53401,7 +138303,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -53409,7 +138341,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -53417,7 +138360,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -53425,7 +138379,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -53433,7 +138404,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -53441,7 +138429,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -53449,7 +138467,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -53457,7 +138499,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -53465,7 +138524,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -53473,7 +138549,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -53481,7 +138574,24 @@ "desc" : "Returns the name of the field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] }, { "name" : "getRawValue", @@ -53489,7 +138599,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getValue", @@ -53497,7 +138624,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getVisibilityEl", @@ -53505,7 +138649,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -53513,7 +138668,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -53521,7 +138700,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -53529,7 +138719,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "inputEl", @@ -53537,7 +138738,18 @@ "desc" : "return the real input element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -53545,7 +138757,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -53553,7 +138776,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "markValid", @@ -53561,7 +138802,18 @@ "desc" : "Mark this field as valid", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -53569,7 +138821,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -53577,7 +138865,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -53585,7 +138884,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -53593,7 +138910,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -53601,7 +138948,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -53609,7 +138974,18 @@ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setDisabled", @@ -53617,7 +138993,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setRawValue", @@ -53625,7 +139019,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setValue", @@ -53633,7 +139045,25 @@ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -53641,7 +139071,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -53649,7 +139090,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -53657,7 +139122,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -53665,7 +139141,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -53673,7 +139166,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "validate", @@ -53681,7 +139204,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -53689,7 +139229,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -53741,11 +139305,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -53775,11 +139335,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -53794,77 +139350,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -53874,7 +139573,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -53882,7 +139599,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -53890,7 +139643,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -53898,7 +139681,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -53906,7 +139700,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -53914,7 +139725,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -53922,7 +139750,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -53930,7 +139788,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -53938,7 +139820,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -53946,7 +139845,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -53954,7 +139870,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -53962,7 +139895,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -53970,7 +139914,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -53978,7 +139946,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -53986,7 +139965,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -53994,7 +139984,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -54002,7 +140003,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -54010,7 +140047,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -54018,7 +140066,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -54026,7 +140092,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -54034,7 +140130,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -54042,7 +140156,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -54050,7 +140182,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -54058,7 +140201,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -54066,7 +140233,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -54074,7 +140252,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -54082,7 +140277,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -54104,12 +140329,7 @@ "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "actionMode", @@ -54127,12 +140347,7 @@ "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", @@ -54174,11 +140389,7 @@ "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "cls", @@ -54238,41 +140449,25 @@ "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidClass", @@ -54296,11 +140491,7 @@ "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", @@ -54498,11 +140689,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "vtype", @@ -54529,133 +140716,416 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "childrenrendered", "type" : "function", "desc" : "Fires when the children have been rendered..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "paste", "type" : "function", "desc" : "Fires after the user pastes into input", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -54665,7 +141135,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -54673,7 +141161,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -54681,7 +141205,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -54689,7 +141243,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -54697,7 +141262,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -54705,7 +141281,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -54713,7 +141306,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -54721,7 +141331,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -54729,7 +141369,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -54737,7 +141401,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -54745,7 +141426,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -54753,7 +141451,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -54761,7 +141476,24 @@ "desc" : "Returns the name of the field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] }, { "name" : "getRawValue", @@ -54769,7 +141501,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getValue", @@ -54777,7 +141526,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getVisibilityEl", @@ -54785,7 +141551,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -54793,7 +141570,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -54801,7 +141602,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -54809,7 +141621,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "inputEl", @@ -54817,7 +141640,18 @@ "desc" : "return the real input element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -54825,7 +141659,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -54833,7 +141678,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "markValid", @@ -54841,7 +141704,18 @@ "desc" : "Mark this field as valid", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -54849,7 +141723,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -54857,7 +141767,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -54865,7 +141786,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -54873,7 +141812,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -54881,7 +141850,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -54889,7 +141876,18 @@ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setDisabled", @@ -54897,7 +141895,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setRawValue", @@ -54905,7 +141921,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setValue", @@ -54913,7 +141947,25 @@ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -54921,7 +141973,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -54929,7 +141992,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -54937,7 +142024,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -54945,7 +142043,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -54953,7 +142068,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "validate", @@ -54961,7 +142106,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -54969,7 +142131,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -55021,11 +142207,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -55055,11 +142237,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -55074,77 +142252,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -55154,7 +142475,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -55162,7 +142501,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -55170,7 +142545,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -55178,7 +142583,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -55186,7 +142602,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -55194,7 +142627,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -55202,7 +142652,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -55210,7 +142690,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -55218,7 +142722,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -55226,7 +142747,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -55234,7 +142772,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -55242,7 +142797,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -55250,7 +142816,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -55258,7 +142848,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -55266,7 +142867,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -55274,7 +142886,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -55282,7 +142905,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -55290,7 +142949,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -55298,7 +142968,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -55306,7 +142994,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -55314,7 +143032,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -55322,7 +143058,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -55330,7 +143084,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -55338,7 +143103,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -55346,7 +143135,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -55354,7 +143154,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -55362,7 +143179,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -55381,21 +143228,72 @@ "type" : "function", "desc" : "Fires before the splitter is dragged", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.SplitBar", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "moved", "type" : "function", "desc" : "Fires when the splitter is moved", "sig" : "function (_self, newSize)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.SplitBar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "the new width or height", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires when the splitter is moved (alias for {@link #event-moved})", "sig" : "function (_self, newSize)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.SplitBar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "the new width or height", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -55405,7 +143303,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -55413,7 +143329,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -55421,7 +143373,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -55429,7 +143411,25 @@ "desc" : "Destroy this splitbar.", "sig" : "(removeEl)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "removeEl", + "type" : "Boolean", + "desc" : "True to remove the element", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -55437,7 +143437,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getAdapter", @@ -55445,7 +143475,24 @@ "desc" : "Get the adapter this SplitBar uses", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "The adapter object" + } + ] }, { "name" : "getMaximumSize", @@ -55453,7 +143500,24 @@ "desc" : "Gets the maximum size for the resizing element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The maximum size" + } + ] }, { "name" : "getMinimumSize", @@ -55461,7 +143525,24 @@ "desc" : "Gets the minimum size for the resizing element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The minimum size" + } + ] }, { "name" : "hasListener", @@ -55469,7 +143550,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "on", @@ -55477,7 +143582,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -55485,7 +143626,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -55493,7 +143645,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -55501,7 +143671,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "setAdapter", @@ -55509,7 +143709,25 @@ "desc" : "Set the adapter this SplitBar uses", "sig" : "(adapter)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adapter", + "type" : "Object", + "desc" : "A SplitBar adapter object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setCurrentSize", @@ -55517,7 +143735,25 @@ "desc" : "Sets the initialize size for the resizing element", "sig" : "(size)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "size", + "type" : "Number", + "desc" : "The initial size", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setMaximumSize", @@ -55525,7 +143761,25 @@ "desc" : "Sets the maximum size for the resizing element", "sig" : "(maxSize)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "maxSize", + "type" : "Number", + "desc" : "The maximum size", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setMinimumSize", @@ -55533,7 +143787,25 @@ "desc" : "Sets the minimum size for the resizing element", "sig" : "(minSize)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "minSize", + "type" : "Number", + "desc" : "The minimum size", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "un", @@ -55541,7 +143813,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -55555,7 +143857,25 @@ "desc" : "Called before drag operations to get the current size of the resizing element.", "sig" : "(s)", "static" : false, - "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter" + "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "s", + "type" : "Roo.bootstrap.SplitBar", + "desc" : "The SplitBar using this adapter", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setElementSize", @@ -55563,7 +143883,37 @@ "desc" : "Called after drag operations to set the size of the resizing element.", "sig" : "(s, newSize, onComplete)", "static" : false, - "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter" + "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "s", + "type" : "Roo.bootstrap.SplitBar", + "desc" : "The SplitBar using this adapter", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new size to set", + "isOptional" : false + }, + { + "name" : "onComplete", + "type" : "Function", + "desc" : "A function to be invoked when resizing is complete", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -55577,7 +143927,25 @@ "desc" : "Called before drag operations to get the current size of the resizing element.", "sig" : "(s)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "s", + "type" : "Roo.bootstrap.SplitBar", + "desc" : "The SplitBar using this adapter", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setElementSize", @@ -55585,7 +143953,37 @@ "desc" : "Called after drag operations to set the size of the resizing element.", "sig" : "(s, newSize, onComplete)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "s", + "type" : "Roo.bootstrap.SplitBar", + "desc" : "The SplitBar using this adapter", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new size to set", + "isOptional" : false + }, + { + "name" : "onComplete", + "type" : "Function", + "desc" : "A function to be invoked when resizing is complete", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -55601,13 +143999,7 @@ "name" : "alert", "type" : "String", "desc" : "r) type alert (changes background / border...)", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [ - "success", - "info", - "warning", - "danger" - ] + "memberOf" : "Roo.bootstrap.Column" }, { "name" : "allowDomMove", @@ -55619,11 +144011,7 @@ "name" : "autoslide", "type" : "Boolean", "desc" : "e) auto slide .. default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "bullets", @@ -55671,43 +144059,25 @@ "name" : "fa", "type" : "String", "desc" : ".) font awesome icon", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [ - "ban", - "check", - "..." - ] + "memberOf" : "Roo.bootstrap.Column" }, { "name" : "fasize", "type" : "Number", "desc" : ".) font awsome size", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [ - "1", - "2", - "...." - ] + "memberOf" : "Roo.bootstrap.Column" }, { "name" : "hidden", "type" : "Boolean", "desc" : "e) hide the element", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Column" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "html", @@ -55719,12 +144089,7 @@ "name" : "icon", "type" : "String", "desc" : ".) glyphicon name", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [ - "info-sign", - "check", - "..." - ] + "memberOf" : "Roo.bootstrap.Column" }, { "name" : "lg", @@ -55772,11 +144137,7 @@ "name" : "showarrow", "type" : "Boolean", "desc" : "e) show arrow default true", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "sm", @@ -55812,11 +144173,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -55843,77 +144200,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -55923,7 +144423,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -55931,7 +144449,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -55939,7 +144493,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -55947,7 +144531,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -55955,7 +144550,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -55963,7 +144575,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -55971,7 +144600,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -55979,7 +144638,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "get", @@ -55987,7 +144670,25 @@ "desc" : "fetch a Navigation Group based on the navigation ID\nif one does not exist , it will get created.", "sig" : "(the)", "static" : true, - "memberOf" : "" + "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" : "getChildContainer", @@ -55995,7 +144696,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -56003,7 +144721,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -56011,7 +144746,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -56019,7 +144771,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -56027,7 +144790,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -56035,7 +144822,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -56043,7 +144841,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -56051,7 +144860,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -56059,7 +144879,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -56067,7 +144923,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "register", @@ -56075,7 +144942,25 @@ "desc" : "register a Navigation item", "sig" : "(the)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.NavItem", + "desc" : "navitem to add", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "register", @@ -56083,7 +144968,25 @@ "desc" : "register a Navigation Group", "sig" : "(the)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "Roo.bootstrap.NavGroup", + "desc" : "navgroup to add", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "releaseCapture", @@ -56091,7 +144994,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -56099,7 +145020,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -56107,7 +145058,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -56115,7 +145084,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -56123,7 +145110,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -56131,7 +145129,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -56139,7 +145161,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "showPanel", @@ -56147,7 +145180,31 @@ "desc" : "show a specific panel", "sig" : "(panel)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panel", + "type" : "Roo.bootstrap.TabPanel|number|string", + "desc" : "to change to (use the tabId to specify a specific one)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "false if panel was not shown (invalid entry or beforedeactivate fails.)" + } + ] }, { "name" : "tooltipEl", @@ -56155,7 +145212,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -56163,7 +145237,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -56221,11 +145325,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "href", @@ -56285,11 +145385,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -56304,91 +145400,272 @@ "type" : "function", "desc" : "Fires before a tab is de-activated - can be used to do validation on a form.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.TabPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "false if there is an error" + } + ] }, { "name" : "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "changed", "type" : "function", "desc" : "Fires when the active status changes", "sig" : "function (_self, state)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.TabPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "state", + "type" : "Boolean", + "desc" : "the new state", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "childrenrendered", "type" : "function", "desc" : "Fires when the children have been rendered..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -56398,7 +145675,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -56406,7 +145701,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -56414,7 +145745,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -56422,7 +145783,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -56430,7 +145802,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -56438,7 +145827,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -56446,7 +145852,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -56454,7 +145890,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -56462,7 +145922,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -56470,7 +145947,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -56478,7 +145972,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -56486,7 +145997,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -56494,7 +146016,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -56502,7 +146048,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -56510,7 +146067,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -56518,7 +146086,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -56526,7 +146105,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -56534,7 +146149,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -56542,7 +146168,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -56550,7 +146194,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -56558,7 +146232,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -56566,7 +146258,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -56574,7 +146284,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -56582,7 +146303,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -56590,7 +146335,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -56598,7 +146354,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -56606,7 +146379,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -56646,11 +146449,7 @@ "name" : "cellSelection", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "cls", @@ -56704,31 +146503,19 @@ "name" : "footerShow", "type" : "Boolean", "desc" : "e) generate tfoot, default true", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "headerShow", "type" : "Boolean", "desc" : "e) generate thead, default true", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "hover", @@ -56752,11 +146539,7 @@ "name" : "loadMask", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "minColumnWidth", @@ -56780,31 +146563,23 @@ "name" : "rowSelection", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "scrollBody", "type" : "Boolean", "desc" : "e) default false - body scrolled / fixed header", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "sm", - "type" : "Roo.grid.RowSelectionModel|Roo.grid.CellSelectionModel", + "type" : "Roo.grid.AbstractSelectionModel", "desc" : "The selection model to use (cell selection is not supported yet)", "memberOf" : "" }, { "name" : "store", - "type" : "Roo.data.Store|Roo.data.SimpleStore", + "type" : "Roo.data.Store", "desc" : "The data store to use", "memberOf" : "" }, @@ -56830,11 +146605,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -56849,168 +146620,660 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "cellclick", "type" : "function", "desc" : "Fires when a cell is clicked", "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Table", + "desc" : "", + "isOptional" : false + }, + { + "name" : "el", + "type" : "Roo.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "cellcontextmenu", "type" : "function", "desc" : "Fires when a cell is right clicked", "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Table", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "cellIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "celldblclick", "type" : "function", "desc" : "Fires when a cell is double clicked", "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Table", + "desc" : "", + "isOptional" : false + }, + { + "name" : "el", + "type" : "Roo.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "childrenrendered", "type" : "function", "desc" : "Fires when the children have been rendered..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "contextmenu", "type" : "function", "desc" : "The raw contextmenu event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "headercontextmenu", "type" : "function", "desc" : "Fires when a header is right clicked", "sig" : "function (_self, columnIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Table", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mousedown", "type" : "function", "desc" : "The raw mousedown event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseout", "type" : "function", "desc" : "Fires when a mouseout occur", "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Table", + "desc" : "", + "isOptional" : false + }, + { + "name" : "el", + "type" : "Roo.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseover", "type" : "function", "desc" : "Fires when a mouseover occur", "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Table", + "desc" : "", + "isOptional" : false + }, + { + "name" : "el", + "type" : "Roo.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rowclass", "type" : "function", "desc" : "Fires when a row is rendered, so you can change add a style to it.", "sig" : "function (_self, rowcfg)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Table", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowcfg", + "type" : "Object", + "desc" : "contains record rowIndex colIndex and rowClass - set rowClass to add a style.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rowclick", "type" : "function", "desc" : "Fires when a row is clicked", "sig" : "function (_self, el, rowIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Table", + "desc" : "", + "isOptional" : false + }, + { + "name" : "el", + "type" : "Roo.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rowcontextmenu", "type" : "function", "desc" : "Fires when a row is right clicked", "sig" : "function (_self, rowIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Table", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rowdblclick", "type" : "function", "desc" : "Fires when a row is double clicked", "sig" : "function (_self, el, rowIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Table", + "desc" : "", + "isOptional" : false + }, + { + "name" : "el", + "type" : "Roo.Element", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rowsrendered", "type" : "function", "desc" : "Fires when all the rows have been rendered", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Table", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -57020,7 +147283,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -57028,7 +147309,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "autoSize", @@ -57036,7 +147353,24 @@ "desc" : "Forces a resize - used by panel.Grid", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "The element" + } + ] }, { "name" : "capture", @@ -57044,7 +147378,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clear", @@ -57052,7 +147416,18 @@ "desc" : "Remove all rows", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -57060,7 +147435,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -57068,7 +147454,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -57076,7 +147479,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "ensureVisible", @@ -57084,7 +147504,37 @@ "desc" : "Scrolls the specified cell into view", "sig" : "(row, col, hscroll)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "row", + "type" : "Number", + "desc" : "The row index", + "isOptional" : false + }, + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "hscroll", + "type" : "Boolean", + "desc" : "false to disable horizontal scrolling", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -57092,7 +147542,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -57100,7 +147580,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "focusCell", @@ -57108,7 +147612,37 @@ "desc" : "Focuses the specified cell.", "sig" : "(row, col, hscroll)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "row", + "type" : "Number", + "desc" : "The row index", + "isOptional" : false + }, + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "hscroll", + "type" : "Boolean", + "desc" : "false to disable horizontal scrolling", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focusRow", @@ -57116,7 +147650,25 @@ "desc" : "Focuses the specified row.", "sig" : "(row)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "row", + "type" : "Number", + "desc" : "The row index", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getCellIndex", @@ -57124,7 +147676,25 @@ "desc" : "get the Column Index from a dom element. (using regex on x-hcol-{colid})", "sig" : "(cell)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cell", + "type" : "domElement", + "desc" : "to look for", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getChildContainer", @@ -57132,7 +147702,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -57140,7 +147727,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getGridEl", @@ -57148,7 +147752,24 @@ "desc" : "Returns the grid's underlying element = used by panel.Grid", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "The element" + } + ] }, { "name" : "getHeaderIndex", @@ -57156,7 +147777,25 @@ "desc" : "get the header TH element for columnIndex", "sig" : "(columnIndex)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getId", @@ -57164,7 +147803,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getRowIndex", @@ -57172,7 +147828,25 @@ "desc" : "get the Row Index from a dom element.", "sig" : "(row)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "row", + "type" : "Roo.Element", + "desc" : "The row to look for", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getVisibilityEl", @@ -57180,7 +147854,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -57188,7 +147873,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -57196,7 +147905,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -57204,7 +147924,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -57212,7 +147943,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -57220,7 +147962,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -57228,7 +148006,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -57236,7 +148025,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -57244,7 +148051,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -57252,7 +148089,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -57260,7 +148115,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setRowVisibility", @@ -57268,7 +148141,31 @@ "desc" : "Show or hide a row.", "sig" : "(rowIndex, state)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "to show or hide", + "isOptional" : false + }, + { + "name" : "state", + "type" : "Boolean", + "desc" : "hide", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -57276,7 +148173,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -57284,7 +148192,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -57292,7 +148224,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -57300,7 +148243,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -57308,7 +148268,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -57372,11 +148362,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -57418,11 +148404,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -57437,77 +148419,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -57517,7 +148642,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -57525,7 +148668,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -57533,7 +148712,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -57541,7 +148750,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -57549,7 +148769,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -57557,7 +148794,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -57565,7 +148819,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -57573,7 +148857,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -57581,7 +148889,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -57589,7 +148914,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -57597,7 +148939,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -57605,7 +148964,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -57613,7 +148983,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -57621,7 +149015,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -57629,7 +149034,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -57637,7 +149053,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -57645,7 +149072,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -57653,7 +149116,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -57661,7 +149135,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -57669,7 +149161,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -57677,7 +149199,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -57685,7 +149225,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -57693,7 +149251,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -57701,7 +149270,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -57709,7 +149302,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -57717,7 +149321,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -57725,7 +149346,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -57825,11 +149476,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "html", @@ -57895,11 +149542,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "width", @@ -57920,77 +149563,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -58000,7 +149786,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -58008,7 +149812,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -58016,7 +149856,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -58024,7 +149894,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -58032,7 +149913,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -58040,7 +149938,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -58048,7 +149963,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -58056,7 +150001,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -58064,7 +150033,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -58072,7 +150058,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -58080,7 +150083,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -58088,7 +150108,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -58096,7 +150127,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -58104,7 +150159,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -58112,7 +150178,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -58120,7 +150197,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -58128,7 +150216,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -58136,7 +150260,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -58144,7 +150279,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -58152,7 +150305,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -58160,7 +150343,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -58168,7 +150369,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -58176,7 +150395,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -58184,7 +150414,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -58192,7 +150446,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -58200,7 +150465,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -58208,7 +150490,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -58278,11 +150590,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -58318,11 +150626,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -58337,77 +150641,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -58417,7 +150864,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -58425,7 +150890,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -58433,7 +150934,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -58441,7 +150972,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -58449,7 +150991,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -58457,7 +151016,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -58465,7 +151041,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -58473,7 +151079,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -58481,7 +151111,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -58489,7 +151136,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -58497,7 +151161,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -58505,7 +151186,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -58513,7 +151205,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -58521,7 +151237,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -58529,7 +151256,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -58537,7 +151275,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -58545,7 +151294,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -58553,7 +151338,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -58561,7 +151357,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -58569,7 +151383,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -58577,7 +151421,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -58585,7 +151447,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -58593,7 +151473,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -58601,7 +151492,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -58609,7 +151524,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -58617,7 +151543,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -58625,7 +151568,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -58641,12 +151614,7 @@ "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "actionMode", @@ -58664,12 +151632,7 @@ "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", @@ -58711,11 +151674,7 @@ "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "cls", @@ -58775,31 +151734,19 @@ "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "html", @@ -58811,11 +151758,7 @@ "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidClass", @@ -58839,11 +151782,7 @@ "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", @@ -58963,15 +151902,7 @@ "name" : "resize", "type" : "string", "desc" : "l)", - "memberOf" : "", - "optvals" : [ - "none", - "both", - "horizontal", - "vertical", - "inherit", - "initial" - ] + "memberOf" : "" }, { "name" : "rows", @@ -59055,11 +151986,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "vtype", @@ -59071,11 +151998,7 @@ "name" : "wrap", "type" : "string", "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a form", - "memberOf" : "", - "optvals" : [ - "soft", - "hard" - ] + "memberOf" : "" }, { "name" : "xattr", @@ -59096,133 +152019,416 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "childrenrendered", "type" : "function", "desc" : "Fires when the children have been rendered..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "paste", "type" : "function", "desc" : "Fires after the user pastes into input", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -59232,7 +152438,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -59240,7 +152464,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -59248,7 +152508,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -59256,7 +152546,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -59264,7 +152565,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -59272,7 +152584,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -59280,7 +152609,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -59288,7 +152634,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -59296,7 +152672,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -59304,7 +152704,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -59312,7 +152729,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -59320,7 +152754,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -59328,7 +152779,24 @@ "desc" : "Returns the name of the field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] }, { "name" : "getRawValue", @@ -59336,7 +152804,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getValue", @@ -59344,7 +152829,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getVisibilityEl", @@ -59352,7 +152854,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -59360,7 +152873,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -59368,7 +152905,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -59376,7 +152924,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "inputEl", @@ -59384,7 +152943,18 @@ "desc" : "return the real textarea element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -59392,7 +152962,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -59400,7 +152981,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "markValid", @@ -59408,7 +153007,18 @@ "desc" : "Mark this field as valid", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -59416,7 +153026,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -59424,7 +153070,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -59432,7 +153089,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -59440,7 +153115,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -59448,7 +153153,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -59456,7 +153179,18 @@ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setDisabled", @@ -59464,7 +153198,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setRawValue", @@ -59472,7 +153224,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setValue", @@ -59480,7 +153250,25 @@ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -59488,7 +153276,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -59496,7 +153295,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -59504,7 +153327,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -59512,7 +153346,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -59520,7 +153371,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "validate", @@ -59528,7 +153409,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -59536,7 +153434,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -59552,12 +153474,7 @@ "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "actionMode", @@ -59575,12 +153492,7 @@ "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", @@ -59622,11 +153534,7 @@ "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "cls", @@ -59680,11 +153588,7 @@ "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "format", @@ -59696,31 +153600,19 @@ "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidClass", @@ -59744,11 +153636,7 @@ "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", @@ -59940,11 +153828,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "vtype", @@ -59971,140 +153855,448 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "childrenrendered", "type" : "function", "desc" : "Fires when the children have been rendered..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "paste", "type" : "function", "desc" : "Fires after the user pastes into input", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "select", "type" : "function", "desc" : "Fires when select a date.", "sig" : "function (_self, date)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.DateField", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Mixed", + "desc" : "The date value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires when this field show.", "sig" : "function (thisthis, date)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "thisthis", + "type" : "Roo.bootstrap.DateField", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Mixed", + "desc" : "The date value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -60114,7 +154306,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -60122,7 +154332,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -60130,7 +154376,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -60138,7 +154414,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -60146,7 +154433,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -60154,7 +154452,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -60162,7 +154477,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -60170,7 +154502,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -60178,7 +154540,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -60186,7 +154572,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -60194,7 +154597,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -60202,7 +154622,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -60210,7 +154647,24 @@ "desc" : "Returns the name of the field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] }, { "name" : "getRawValue", @@ -60218,7 +154672,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getValue", @@ -60226,7 +154697,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getVisibilityEl", @@ -60234,7 +154722,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -60242,7 +154741,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -60250,7 +154773,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -60258,7 +154792,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "inputEl", @@ -60266,7 +154811,18 @@ "desc" : "return the real input element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -60274,7 +154830,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -60282,7 +154849,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "markValid", @@ -60290,7 +154875,18 @@ "desc" : "Mark this field as valid", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -60298,7 +154894,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -60306,7 +154938,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -60314,7 +154957,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -60322,7 +154983,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -60330,7 +155021,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -60338,7 +155047,18 @@ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setDisabled", @@ -60346,7 +155066,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setRawValue", @@ -60354,7 +155092,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setValue", @@ -60362,7 +155118,25 @@ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -60370,7 +155144,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -60378,7 +155163,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -60386,7 +155195,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -60394,7 +155214,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -60402,7 +155239,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "validate", @@ -60410,7 +155277,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -60418,7 +155302,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -60432,7 +155340,18 @@ "desc" : "", "sig" : "()\n{\n\n}", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -60448,12 +155367,7 @@ "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "actionMode", @@ -60471,12 +155385,7 @@ "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", @@ -60518,21 +155427,13 @@ "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "caret", "type" : "String", "desc" : "r) BS3 only - carat fa name", - "memberOf" : "", - "optvals" : [ - "search", - "calendar" - ] + "memberOf" : "" }, { "name" : "cls", @@ -60586,31 +155487,19 @@ "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "hideTrigger", @@ -60622,11 +155511,7 @@ "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidClass", @@ -60650,11 +155535,7 @@ "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", @@ -60774,11 +155655,7 @@ "name" : "removable", "type" : "Boolean", "desc" : "e) special filter default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "selectOnFocus", @@ -60862,11 +155739,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "vtype", @@ -60893,133 +155766,416 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "childrenrendered", "type" : "function", "desc" : "Fires when the children have been rendered..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "paste", "type" : "function", "desc" : "Fires after the user pastes into input", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -61029,7 +156185,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -61037,7 +156211,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "autoSize", @@ -61045,7 +156255,18 @@ "desc" : "", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -61053,7 +156274,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -61061,7 +156312,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -61069,7 +156331,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -61077,7 +156350,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -61085,7 +156375,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -61093,7 +156400,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -61101,7 +156438,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -61109,7 +156470,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -61117,7 +156495,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -61125,7 +156520,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -61133,7 +156545,24 @@ "desc" : "Returns the name of the field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "name The name field" + } + ] }, { "name" : "getRawValue", @@ -61141,7 +156570,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getValue", @@ -61149,7 +156595,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getVisibilityEl", @@ -61157,7 +156620,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -61165,7 +156639,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -61173,7 +156671,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -61181,7 +156690,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "inputEl", @@ -61189,7 +156709,18 @@ "desc" : "return the real input element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -61197,7 +156728,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -61205,7 +156747,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "markValid", @@ -61213,7 +156773,18 @@ "desc" : "Mark this field as valid", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -61221,7 +156792,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onTriggerClick", @@ -61229,7 +156836,25 @@ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", "sig" : "(e)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -61237,7 +156862,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -61245,7 +156881,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -61253,7 +156907,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -61261,7 +156945,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -61269,7 +156971,18 @@ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setDisabled", @@ -61277,7 +156990,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setRawValue", @@ -61285,7 +157016,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setValue", @@ -61293,7 +157042,25 @@ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -61301,7 +157068,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -61309,7 +157087,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -61317,7 +157119,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -61325,7 +157138,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -61333,7 +157163,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "validate", @@ -61341,7 +157201,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -61349,7 +157226,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.bootstrap.Input" + "memberOf" : "Roo.bootstrap.Input", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -61419,21 +157320,13 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "isDocument", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "listeners", @@ -61445,11 +157338,7 @@ "name" : "loadMask", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "loadingText", @@ -61515,11 +157404,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -61534,175 +157419,554 @@ "type" : "function", "desc" : "Fire when arrange the file data", "sig" : "function (_self, formData)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + }, + { + "name" : "formData", + "type" : "Object", + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeloadcanvas", "type" : "function", "desc" : "Fire before load the canvas", "sig" : "function (_self, src)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + }, + { + "name" : "src", + "type" : "String", + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeselectfile", "type" : "function", "desc" : "Fire before select file", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "crop", "type" : "function", "desc" : "Fire after initEvent", "sig" : "function (_self, data)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + }, + { + "name" : "data", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "download", "type" : "function", "desc" : "Fire when download the image", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enable", "type" : "function", "desc" : "Fires after the component is enabled.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "exception", "type" : "function", "desc" : "Fire when get exception", "sig" : "function (_self, xhr)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + }, + { + "name" : "xhr", + "type" : "XMLHttpRequest", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "footerbuttonclick", "type" : "function", "desc" : "Fire when footerbuttonclick", "sig" : "function (_self, type)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + }, + { + "name" : "type", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "initial", "type" : "function", "desc" : "Fire after initEvent", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "inspect", "type" : "function", "desc" : "Fire when inspect the file", "sig" : "function (_self, file)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + }, + { + "name" : "file", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "prepare", "type" : "function", "desc" : "Fire when preparing the file data", "sig" : "function (_self, file)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + }, + { + "name" : "file", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fire when resize", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rotate", "type" : "function", "desc" : "Fire when rotate the image", "sig" : "function (_self, pos)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + }, + { + "name" : "pos", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "trash", "type" : "function", "desc" : "Fire when trash image", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "upload", "type" : "function", "desc" : "Fire when xhr upload the file", "sig" : "function (_self, data)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.UploadCropbox", + "desc" : "", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -61712,7 +157976,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -61720,7 +158002,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -61728,7 +158046,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -61736,7 +158084,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -61744,7 +158103,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -61752,7 +158128,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -61760,7 +158153,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -61768,7 +158191,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -61776,7 +158223,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -61784,7 +158248,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -61792,7 +158273,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -61800,7 +158298,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -61808,7 +158317,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -61816,7 +158349,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -61824,7 +158368,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -61832,7 +158387,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -61840,7 +158406,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -61848,7 +158450,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -61856,7 +158469,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -61864,7 +158495,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -61872,7 +158533,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -61880,7 +158559,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -61888,7 +158585,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -61896,7 +158604,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -61904,7 +158636,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -61912,7 +158655,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -61920,7 +158680,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -61983,11 +158773,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "href", @@ -62029,11 +158815,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -62048,84 +158830,240 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "The img click event for the img.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -62135,7 +159073,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -62143,7 +159099,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -62151,7 +159143,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -62159,7 +159181,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -62167,7 +159200,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -62175,7 +159225,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -62183,7 +159250,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -62191,7 +159288,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -62199,7 +159320,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -62207,7 +159345,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -62215,7 +159370,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -62223,7 +159395,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -62231,7 +159414,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -62239,7 +159446,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -62247,7 +159465,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -62255,7 +159484,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -62263,7 +159503,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -62271,7 +159547,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -62279,7 +159566,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -62287,7 +159592,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -62295,7 +159630,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -62303,7 +159656,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -62311,7 +159682,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -62319,7 +159701,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -62327,7 +159733,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -62335,7 +159752,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -62343,7 +159777,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -62395,11 +159859,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -62429,11 +159889,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -62448,77 +159904,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -62528,7 +160127,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -62536,7 +160153,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -62544,7 +160197,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -62552,7 +160235,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -62560,7 +160254,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -62568,7 +160279,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -62576,7 +160304,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -62584,7 +160342,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -62592,7 +160374,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -62600,7 +160399,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -62608,7 +160424,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -62616,7 +160449,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -62624,7 +160468,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -62632,7 +160500,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -62640,7 +160519,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -62648,7 +160538,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -62656,7 +160557,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -62664,7 +160601,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -62672,7 +160620,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -62680,7 +160646,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -62688,7 +160684,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -62696,7 +160710,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -62704,7 +160736,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -62712,7 +160755,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -62720,7 +160787,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -62728,7 +160806,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -62736,7 +160831,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -62817,11 +160942,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "icon", @@ -62857,11 +160978,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -62876,77 +160993,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -62956,7 +161216,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -62964,7 +161242,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -62972,7 +161286,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -62980,7 +161324,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -62988,7 +161343,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -62996,7 +161368,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -63004,7 +161393,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -63012,7 +161431,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -63020,7 +161463,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -63028,7 +161488,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -63036,7 +161513,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -63044,7 +161538,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -63052,7 +161557,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -63060,7 +161589,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -63068,7 +161608,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -63076,7 +161627,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -63084,7 +161646,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -63092,7 +161690,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -63100,7 +161709,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -63108,7 +161735,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -63116,7 +161773,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -63124,7 +161799,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -63132,7 +161825,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -63140,7 +161844,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -63148,7 +161876,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -63156,7 +161895,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -63164,7 +161920,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -63216,11 +162002,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "icon", @@ -63244,11 +162026,7 @@ "name" : "showtabs", "type" : "Boolean", "desc" : "e) show the tabs default true", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "style", @@ -63260,11 +162038,7 @@ "name" : "tabScrollable", "type" : "Boolean", "desc" : "e) tab scrollable when mobile view default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "title", @@ -63282,11 +162056,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -63301,91 +162071,260 @@ "type" : "function", "desc" : "When a pane is activated", "sig" : "function (pane)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "pane", + "type" : "Roo.bootstrap.dash.TabPane", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addpane", "type" : "function", "desc" : "When a pane is added", "sig" : "function (pane)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "pane", + "type" : "Roo.bootstrap.dash.TabPane", + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -63395,7 +162334,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -63403,7 +162360,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -63411,7 +162404,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -63419,7 +162442,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -63427,7 +162461,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -63435,7 +162486,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -63443,7 +162511,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -63451,7 +162549,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -63459,7 +162581,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -63467,7 +162606,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -63475,7 +162631,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -63483,7 +162656,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -63491,7 +162675,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -63499,7 +162707,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -63507,7 +162726,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -63515,7 +162745,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -63523,7 +162764,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -63531,7 +162808,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -63539,7 +162827,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -63547,7 +162853,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -63555,7 +162891,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -63563,7 +162917,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setTitle", @@ -63571,7 +162943,25 @@ "desc" : "Updates the box title", "sig" : "(html)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "html", + "type" : "String", + "desc" : "to set the title to.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -63579,7 +162969,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -63587,7 +162988,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -63595,7 +163020,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -63603,7 +163039,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -63611,7 +163064,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -63627,11 +163110,7 @@ "name" : "active", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "", - "optvals" : [ - "false", - "true" - ] + "memberOf" : "" }, { "name" : "allowDomMove", @@ -63673,11 +163152,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -63713,11 +163188,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -63732,84 +163203,240 @@ "type" : "function", "desc" : "When a pane is activated", "sig" : "function (pane)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "pane", + "type" : "Roo.bootstrap.dash.TabPane", + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -63819,7 +163446,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -63827,7 +163472,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -63835,7 +163516,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -63843,7 +163554,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -63851,7 +163573,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -63859,7 +163598,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -63867,7 +163623,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -63875,7 +163661,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -63883,7 +163693,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -63891,7 +163718,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -63899,7 +163743,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -63907,7 +163768,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -63915,7 +163787,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -63923,7 +163819,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -63931,7 +163838,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -63939,7 +163857,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -63947,7 +163876,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -63955,7 +163920,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -63963,7 +163939,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -63971,7 +163965,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -63979,7 +164003,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -63987,7 +164029,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setTitle", @@ -63995,7 +164055,25 @@ "desc" : "Updates the tab title", "sig" : "(html)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "html", + "type" : "String", + "desc" : "to set the title to.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisibilityEl", @@ -64003,7 +164081,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -64011,7 +164100,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -64019,7 +164132,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -64027,7 +164151,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -64035,7 +164176,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -64067,7 +164238,18 @@ "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -64111,7 +164293,31 @@ "desc" : "Add the passed ContentPanel(s)", "sig" : "(panel)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panel", + "type" : "ContentPanel...", + "desc" : "The ContentPanel(s) to add (you can pass more than one)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel added (if only one was added)" + } + ] }, { "name" : "addEvents", @@ -64119,7 +164325,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -64127,7 +164351,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -64135,7 +164395,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "fireEvent", @@ -64143,7 +164433,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getActivePanel", @@ -64151,7 +164471,24 @@ "desc" : "Get the active panel for this region.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The active panel or null" + } + ] }, { "name" : "getEl", @@ -64159,7 +164496,24 @@ "desc" : "Returns the container element for this region.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] }, { "name" : "getPanel", @@ -64167,7 +164521,31 @@ "desc" : "Returns the panel specified or null if it's not in this region.", "sig" : "(panel)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "" + } + ] }, { "name" : "getPosition", @@ -64175,7 +164553,24 @@ "desc" : "Returns this regions position (north/south/east/west/center).", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -64183,7 +164578,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hasPanel", @@ -64191,7 +164610,31 @@ "desc" : "Returns true if the panel is in this region.", "sig" : "(panel)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isVisible", @@ -64199,7 +164642,24 @@ "desc" : "Returns true if this region is currently visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "on", @@ -64207,7 +164667,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -64215,7 +164711,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -64223,7 +164730,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "remove", @@ -64231,7 +164756,37 @@ "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.", "sig" : "(panel, preservePanel)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + }, + { + "name" : "preservePanel", + "type" : "Boolean", + "desc" : "Overrides the config preservePanel option", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel that was removed" + } + ] }, { "name" : "removeListener", @@ -64239,7 +164794,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "resizeTo", @@ -64247,7 +164832,25 @@ "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.", "sig" : "(newSize)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new width or height", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "showPanel", @@ -64255,7 +164858,31 @@ "desc" : "Show the specified panel.", "sig" : "(panelId)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panelId", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The shown panel or null" + } + ] }, { "name" : "un", @@ -64263,7 +164890,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -64315,11 +164972,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -64349,11 +165002,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -64368,105 +165017,306 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "layout", "type" : "function", "desc" : "Fires when a layout is performed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.layout.Manager" + "memberOf" : "Roo.bootstrap.layout.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutManager", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "regioncollapsed", "type" : "function", "desc" : "Fires when a region is collapsed.", "sig" : "function (region)\n{\n\n}", - "memberOf" : "Roo.bootstrap.layout.Manager" + "memberOf" : "Roo.bootstrap.layout.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The collapsed region", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "regionexpanded", "type" : "function", "desc" : "Fires when a region is expanded.", "sig" : "function (region)\n{\n\n}", - "memberOf" : "Roo.bootstrap.layout.Manager" + "memberOf" : "Roo.bootstrap.layout.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The expanded region", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "regionresized", "type" : "function", "desc" : "Fires when the user resizes a region.", "sig" : "function (region, newSize)\n{\n\n}", - "memberOf" : "Roo.bootstrap.layout.Manager" + "memberOf" : "Roo.bootstrap.layout.Manager", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The resized region", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new size (width for east/west, height for north/south)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -64476,7 +165326,37 @@ "desc" : "Adds a ContentPanel (or subclass) to this layout.", "sig" : "(target, panel)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "target", + "type" : "String", + "desc" : "The target region key (north, south, east, west or center).", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The panel to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The added panel" + } + ] }, { "name" : "addEvents", @@ -64484,7 +165364,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -64492,7 +165390,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "addRegion", @@ -64500,7 +165434,37 @@ "desc" : "Creates and adds a new region if it doesn't already exist.", "sig" : "(target, config)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "target", + "type" : "String", + "desc" : "The target region key (north, south, east, west or center).", + "isOptional" : false + }, + { + "name" : "config", + "type" : "Object", + "desc" : "The regions config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BorderLayoutRegion", + "desc" : "The new region" + } + ] }, { "name" : "addxtype", @@ -64508,7 +165472,25 @@ "desc" : "Adds a xtype elements to the layout.\n
\n\nlayout.addxtype({\n       xtype : 'ContentPanel',\n       region: 'west',\n       items: [ .... ]\n   }\n);\n\nlayout.addxtype({\n        xtype : 'NestedLayoutPanel',\n        region: 'west',\n        layout: {\n           center: { },\n           west: { }   \n        },\n        items : [ ... list of content panels or nested layout panels.. ]\n   }\n);\n
", "sig" : "(cfg)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cfg", + "type" : "Object", + "desc" : "Xtype definition of item to add.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beginUpdate", @@ -64516,7 +165498,18 @@ "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.layout.Manager" + "memberOf" : "Roo.bootstrap.layout.Manager", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -64524,7 +165517,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -64532,7 +165555,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -64540,7 +165574,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -64548,7 +165599,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "endUpdate", @@ -64556,7 +165624,25 @@ "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout", "sig" : "(noLayout)", "static" : false, - "memberOf" : "Roo.bootstrap.layout.Manager" + "memberOf" : "Roo.bootstrap.layout.Manager", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "noLayout", + "type" : "Boolean", + "desc" : "true to disable a layout update", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "findPanel", @@ -64564,7 +165650,31 @@ "desc" : "Searches all regions for a panel with the specified id", "sig" : "(panelId)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panelId", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel or null if it wasn't found" + } + ] }, { "name" : "fireEvent", @@ -64572,7 +165682,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -64580,7 +165720,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -64588,7 +165752,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -64596,7 +165777,24 @@ "desc" : "Returns the Element this layout is bound to.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.layout.Manager" + "memberOf" : "Roo.bootstrap.layout.Manager", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] }, { "name" : "getId", @@ -64604,7 +165802,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getRegion", @@ -64612,7 +165827,31 @@ "desc" : "Returns the specified region.", "sig" : "(target)", "static" : false, - "memberOf" : "Roo.bootstrap.layout.Manager" + "memberOf" : "Roo.bootstrap.layout.Manager", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "target", + "type" : "String", + "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.LayoutRegion", + "desc" : "" + } + ] }, { "name" : "getViewSize", @@ -64620,7 +165859,24 @@ "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.layout.Manager" + "memberOf" : "Roo.bootstrap.layout.Manager", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The size as an object {width: (the width), height: (the height)}" + } + ] }, { "name" : "getVisibilityEl", @@ -64628,7 +165884,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -64636,7 +165903,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -64644,7 +165935,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -64652,7 +165954,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isUpdating", @@ -64660,7 +165973,24 @@ "desc" : "Returns true if this layout is currently being updated", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.layout.Manager" + "memberOf" : "Roo.bootstrap.layout.Manager", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isVisible", @@ -64668,7 +165998,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "layout", @@ -64676,7 +166017,18 @@ "desc" : "Performs a layout update.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -64684,7 +166036,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -64692,7 +166080,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -64700,7 +166099,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "remove", @@ -64708,7 +166125,37 @@ "desc" : "Remove a ContentPanel (or subclass) to this layout.", "sig" : "(target, panel)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "target", + "type" : "String", + "desc" : "The target region key (north, south, east, west or center).", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Number/String/Roo.ContentPanel", + "desc" : "The index, id or panel to remove", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The removed panel" + } + ] }, { "name" : "removeListener", @@ -64716,7 +166163,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -64724,7 +166201,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -64732,7 +166227,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -64740,7 +166253,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -64748,7 +166272,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -64756,7 +166304,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "showPanel", @@ -64764,7 +166323,31 @@ "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.", "sig" : "(panelId)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panelId", + "type" : "String/ContentPanel", + "desc" : "The panels id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The shown panel or null" + } + ] }, { "name" : "tooltipEl", @@ -64772,7 +166355,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -64780,7 +166380,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -64832,11 +166462,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -64866,11 +166492,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -64885,105 +166507,306 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "layout", "type" : "function", "desc" : "Fires when a layout is performed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutManager", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "regioncollapsed", "type" : "function", "desc" : "Fires when a region is collapsed.", "sig" : "function (region)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The collapsed region", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "regionexpanded", "type" : "function", "desc" : "Fires when a region is expanded.", "sig" : "function (region)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The expanded region", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "regionresized", "type" : "function", "desc" : "Fires when the user resizes a region.", "sig" : "function (region, newSize)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "region", + "type" : "Roo.LayoutRegion", + "desc" : "The resized region", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new size (width for east/west, height for north/south)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -64993,7 +166816,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -65001,7 +166842,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "beginUpdate", @@ -65009,7 +166886,18 @@ "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -65017,7 +166905,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -65025,7 +166943,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -65033,7 +166962,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -65041,7 +166987,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "endUpdate", @@ -65049,7 +167012,25 @@ "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout", "sig" : "(noLayout)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "noLayout", + "type" : "Boolean", + "desc" : "true to disable a layout update", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -65057,7 +167038,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -65065,7 +167076,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -65073,7 +167108,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -65081,7 +167133,24 @@ "desc" : "Returns the Element this layout is bound to.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] }, { "name" : "getId", @@ -65089,7 +167158,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getRegion", @@ -65097,7 +167183,31 @@ "desc" : "Returns the specified region.", "sig" : "(target)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "target", + "type" : "String", + "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.LayoutRegion", + "desc" : "" + } + ] }, { "name" : "getViewSize", @@ -65105,7 +167215,24 @@ "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The size as an object {width: (the width), height: (the height)}" + } + ] }, { "name" : "getVisibilityEl", @@ -65113,7 +167240,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -65121,7 +167259,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -65129,7 +167291,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -65137,7 +167310,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isUpdating", @@ -65145,7 +167329,24 @@ "desc" : "Returns true if this layout is currently being updated", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isVisible", @@ -65153,7 +167354,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -65161,7 +167373,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -65169,7 +167417,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -65177,7 +167436,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -65185,7 +167462,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -65193,7 +167500,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -65201,7 +167526,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -65209,7 +167552,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -65217,7 +167571,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -65225,7 +167603,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -65233,7 +167622,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -65241,7 +167647,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -65347,11 +167783,7 @@ "name" : "overflow", "type" : "String", "desc" : "e) if you have menus in the region, then you need to set this to visible.", - "memberOf" : "", - "optvals" : [ - "hidden", - "visible" - ] + "memberOf" : "" }, { "name" : "preferredTabWidth", @@ -65393,11 +167825,7 @@ "name" : "tabPosition", "type" : "String", "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")", - "memberOf" : "", - "optvals" : [ - "top", - "bottom" - ] + "memberOf" : "" }, { "name" : "title", @@ -65432,7 +167860,31 @@ "desc" : "Adds the passed ContentPanel(s) to this region.", "sig" : "(panel)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panel", + "type" : "ContentPanel...", + "desc" : "The ContentPanel(s) to add (you can pass more than one)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel added (if only one was added; null otherwise)" + } + ] }, { "name" : "addEvents", @@ -65440,7 +167892,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -65448,7 +167918,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "animateCollapse", @@ -65456,7 +167962,25 @@ "desc" : "Collapses this region.", "sig" : "(skipAnim)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "skipAnim", + "type" : "Boolean", + "desc" : "(optional) true to collapse the element without animation (if animate is true)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "animateExpand", @@ -65464,7 +167988,31 @@ "desc" : "Expands this region if it was previously collapsed.", "sig" : "(e, skipAnim)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event that triggered the expand (or null if calling manually)", + "isOptional" : false + }, + { + "name" : "skipAnim", + "type" : "Boolean", + "desc" : "(optional) true to expand the element without animation (if animate is true)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "capture", @@ -65472,7 +168020,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "fireEvent", @@ -65480,7 +168058,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getActivePanel", @@ -65488,7 +168096,24 @@ "desc" : "Get the active panel for this region.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The active panel or null" + } + ] }, { "name" : "getBox", @@ -65496,7 +168121,25 @@ "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)", "sig" : "(title)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \" \")", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -65504,7 +168147,24 @@ "desc" : "Returns the container element for this region.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] }, { "name" : "getPanel", @@ -65512,7 +168172,31 @@ "desc" : "Returns the panel specified or null if it's not in this region.", "sig" : "(panel)", "static" : false, - "memberOf" : "Roo.bootstrap.layout.Basic" + "memberOf" : "Roo.bootstrap.layout.Basic", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "" + } + ] }, { "name" : "getPosition", @@ -65520,7 +168204,24 @@ "desc" : "Returns this regions position (north/south/east/west/center).", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.layout.Basic" + "memberOf" : "Roo.bootstrap.layout.Basic", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getTabs", @@ -65528,7 +168229,24 @@ "desc" : "Returns the TabPanel component used by this region", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanel", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -65536,7 +168254,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hasPanel", @@ -65544,7 +168286,31 @@ "desc" : "Returns true if the panel is in this region.", "sig" : "(panel)", "static" : false, - "memberOf" : "Roo.bootstrap.layout.Basic" + "memberOf" : "Roo.bootstrap.layout.Basic", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "hide", @@ -65552,7 +168318,18 @@ "desc" : "Hides this region.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hidePanel", @@ -65560,7 +168337,25 @@ "desc" : "Hides the tab for the specified panel.", "sig" : "(panel)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "isVisible", @@ -65568,7 +168363,24 @@ "desc" : "Returns true if this region is currently visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "on", @@ -65576,7 +168388,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -65584,7 +168432,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -65592,7 +168451,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "remove", @@ -65600,7 +168477,37 @@ "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.", "sig" : "(panel, preservePanel)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + }, + { + "name" : "preservePanel", + "type" : "Boolean", + "desc" : "Overrides the config preservePanel option", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel that was removed" + } + ] }, { "name" : "removeListener", @@ -65608,7 +168515,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "resizeTo", @@ -65616,7 +168553,25 @@ "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.", "sig" : "(newSize)", "static" : false, - "memberOf" : "Roo.bootstrap.layout.Basic" + "memberOf" : "Roo.bootstrap.layout.Basic", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new width or height", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", @@ -65624,7 +168579,18 @@ "desc" : "Shows this region if it was previously hidden.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "showPanel", @@ -65632,7 +168598,31 @@ "desc" : "Shows the specified panel.", "sig" : "(panelId)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panelId", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The shown panel, or null if a panel could not be found from panelId" + } + ] }, { "name" : "un", @@ -65640,7 +168630,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "unhidePanel", @@ -65648,7 +168668,25 @@ "desc" : "Unhides the tab for a previously hidden panel.", "sig" : "(panel)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -65796,11 +168834,7 @@ "name" : "tabPosition", "type" : "String", "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [ - "top", - "bottom" - ] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "title", @@ -65833,84 +168867,282 @@ "type" : "function", "desc" : "Fires when this region before collapse.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeremove", "type" : "function", "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.", "sig" : "function (_self, panel, e)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The panel", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "The cancel event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "collapsed", "type" : "function", "desc" : "Fires when this region is collapsed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "expanded", "type" : "function", "desc" : "Fires when this region is expanded.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalidated", "type" : "function", "desc" : "Fires when the layout for this region is changed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "panelactivated", "type" : "function", "desc" : "Fires when a panel is activated.", "sig" : "function (_self, panel)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The activated panel", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "paneladded", "type" : "function", "desc" : "Fires when a panel is added.", "sig" : "function (_self, panel)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The panel", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "panelremoved", "type" : "function", "desc" : "Fires when a panel is removed.", "sig" : "function (_self, panel)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "panel", + "type" : "Roo.ContentPanel", + "desc" : "The panel", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resized", "type" : "function", "desc" : "Fires when the user resizes this region.", "sig" : "function (_self, newSize)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new size (width for east/west, height for north/south)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "slidehide", "type" : "function", "desc" : "Fires when this region slides out of view.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "slideshow", "type" : "function", "desc" : "Fires when this region is slid into view.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "visibilitychange", "type" : "function", "desc" : "Fires when this region is shown or hidden", "sig" : "function (_self, visibility)\n{\n\n}", - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.LayoutRegion", + "desc" : "", + "isOptional" : false + }, + { + "name" : "visibility", + "type" : "Boolean", + "desc" : "true or false", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -65920,7 +169152,31 @@ "desc" : "Adds the passed ContentPanel(s) to this region.", "sig" : "(panel)", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panel", + "type" : "ContentPanel...", + "desc" : "The ContentPanel(s) to add (you can pass more than one)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel added (if only one was added; null otherwise)" + } + ] }, { "name" : "addEvents", @@ -65928,7 +169184,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -65936,7 +169210,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -65944,7 +169254,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "collapse", @@ -65952,7 +169292,25 @@ "desc" : "Collapses this region.", "sig" : "(skipAnim)", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "skipAnim", + "type" : "Boolean", + "desc" : "(optional) true to collapse the element without animation (if animate is true)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "expand", @@ -65960,7 +169318,31 @@ "desc" : "Expands this region if it was previously collapsed.", "sig" : "(e, skipAnim)", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event that triggered the expand (or null if calling manually)", + "isOptional" : false + }, + { + "name" : "skipAnim", + "type" : "Boolean", + "desc" : "(optional) true to expand the element without animation (if animate is true)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -65968,7 +169350,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getActivePanel", @@ -65976,7 +169388,24 @@ "desc" : "Get the active panel for this region.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The active panel or null" + } + ] }, { "name" : "getEl", @@ -65984,7 +169413,24 @@ "desc" : "Returns the container element for this region.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] }, { "name" : "getPanel", @@ -65992,7 +169438,31 @@ "desc" : "Returns the panel specified or null if it's not in this region.", "sig" : "(panel)", "static" : false, - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "" + } + ] }, { "name" : "getPosition", @@ -66000,7 +169470,24 @@ "desc" : "Returns this regions position (north/south/east/west/center).", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getSplitBar", @@ -66008,7 +169495,24 @@ "desc" : "Returns the {@link Roo.SplitBar} for this region.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.SplitBar", + "desc" : "" + } + ] }, { "name" : "getTabs", @@ -66016,7 +169520,24 @@ "desc" : "Returns the TabPanel component used by this region", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanel", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -66024,7 +169545,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hasPanel", @@ -66032,7 +169577,31 @@ "desc" : "Returns true if the panel is in this region.", "sig" : "(panel)", "static" : false, - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panels index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "hide", @@ -66040,7 +169609,18 @@ "desc" : "Hides this region.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hidePanel", @@ -66048,7 +169628,25 @@ "desc" : "Hides the tab for the specified panel.", "sig" : "(panel)", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "isVisible", @@ -66056,7 +169654,24 @@ "desc" : "Returns true if this region is currently visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "on", @@ -66064,7 +169679,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -66072,7 +169723,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -66080,7 +169742,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "remove", @@ -66088,7 +169768,37 @@ "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.", "sig" : "(panel, preservePanel)", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + }, + { + "name" : "preservePanel", + "type" : "Boolean", + "desc" : "Overrides the config preservePanel option", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The panel that was removed" + } + ] }, { "name" : "removeListener", @@ -66096,7 +169806,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "resizeTo", @@ -66104,7 +169844,25 @@ "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.", "sig" : "(newSize)", "static" : false, - "memberOf" : "Roo.BasicLayoutRegion" + "memberOf" : "Roo.BasicLayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "newSize", + "type" : "Number", + "desc" : "The new width or height", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setCollapsedTitle", @@ -66112,7 +169870,25 @@ "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)", "sig" : "(title)", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \" \")", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", @@ -66120,7 +169896,18 @@ "desc" : "Shows this region if it was previously hidden.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "showPanel", @@ -66128,7 +169915,31 @@ "desc" : "Shows the specified panel.", "sig" : "(panelId)", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panelId", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "The shown panel, or null if a panel could not be found from panelId" + } + ] }, { "name" : "un", @@ -66136,7 +169947,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "unhidePanel", @@ -66144,7 +169985,25 @@ "desc" : "Unhides the tab for a previously hidden panel.", "sig" : "(panel)", "static" : false, - "memberOf" : "Roo.LayoutRegion" + "memberOf" : "Roo.LayoutRegion", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "panel", + "type" : "Number/String/ContentPanel", + "desc" : "The panel's index, id or the panel itself", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -66195,11 +170054,7 @@ "name" : "disable", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "disableClass", @@ -66211,11 +170066,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "href", @@ -66257,11 +170108,7 @@ "name" : "preventDefault", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "style", @@ -66273,11 +170120,7 @@ "name" : "submenu", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "tooltip", @@ -66289,11 +170132,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -66308,98 +170147,292 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "The raw click event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseout", "type" : "function", "desc" : "Fires when the mouse exits this menu", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.menu.Item", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseover", "type" : "function", "desc" : "Fires when the mouse is hovering over this menu", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.menu.Item", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -66409,7 +170442,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -66417,7 +170468,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -66425,7 +170512,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -66433,7 +170550,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -66441,7 +170569,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -66449,7 +170594,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -66457,7 +170619,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -66465,7 +170657,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -66473,7 +170689,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -66481,7 +170714,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -66489,7 +170739,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -66497,7 +170764,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -66505,7 +170783,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -66513,7 +170815,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -66521,7 +170834,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -66529,7 +170853,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -66537,7 +170872,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -66545,7 +170916,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -66553,7 +170935,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -66561,7 +170961,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -66569,7 +170999,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -66577,7 +171025,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -66585,7 +171051,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -66593,7 +171070,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -66601,7 +171102,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -66609,7 +171121,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -66617,7 +171146,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -66669,11 +171228,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "html", @@ -66721,26 +171276,13 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "weight", "type" : "String", "desc" : "e)", - "memberOf" : "", - "optvals" : [ - "default", - "primary", - "success", - "info", - "warning", - "danger", - "inverse" - ] + "memberOf" : "" }, { "name" : "xattr", @@ -66755,84 +171297,246 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforehide", "type" : "function", "desc" : "Fires before this menu is hidden", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.menu.Menu", + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeshow", "type" : "function", "desc" : "Fires before this menu is displayed", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.menu.Menu", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after this menu is hidden", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after this menu is displayed", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -66842,7 +171546,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -66850,7 +171572,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -66858,7 +171616,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -66866,7 +171654,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -66874,7 +171673,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -66882,7 +171698,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -66890,7 +171723,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -66898,7 +171761,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -66906,7 +171793,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -66914,7 +171818,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -66922,7 +171843,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -66930,7 +171868,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -66938,7 +171887,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -66946,7 +171919,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -66954,7 +171938,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -66962,7 +171957,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -66970,7 +171976,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -66978,7 +172020,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -66986,7 +172039,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -66994,7 +172065,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -67002,7 +172103,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -67010,7 +172129,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -67018,7 +172155,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -67026,7 +172174,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -67034,7 +172206,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -67042,7 +172225,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -67050,7 +172250,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -67102,11 +172332,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -67136,11 +172362,7 @@ "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xattr", @@ -67155,77 +172377,220 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "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" + "memberOf" : "Roo.bootstrap.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.bootstrap.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -67235,7 +172600,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -67243,7 +172626,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -67251,7 +172670,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -67259,7 +172708,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -67267,7 +172727,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -67275,7 +172752,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -67283,7 +172777,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -67291,7 +172815,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getChildContainer", @@ -67299,7 +172847,24 @@ "desc" : "Fetch the element to add children to", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "getEl", @@ -67307,7 +172872,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -67315,7 +172897,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getVisibilityEl", @@ -67323,7 +172922,18 @@ "desc" : "Get the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -67331,7 +172941,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -67339,7 +172973,18 @@ "desc" : "Hide a component - adds 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initEvents", @@ -67347,7 +172992,18 @@ "desc" : "Initialize Events for the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", @@ -67355,7 +173011,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -67363,7 +173030,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -67371,7 +173074,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -67379,7 +173093,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -67387,7 +173119,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -67395,7 +173157,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -67403,7 +173183,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisibilityEl", @@ -67411,7 +173209,18 @@ "desc" : "Set the element that will be used to show or hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setVisible", @@ -67419,7 +173228,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -67427,7 +173260,18 @@ "desc" : "Show a component - removes 'hidden' class", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "memberOf" : "Roo.bootstrap.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "tooltipEl", @@ -67435,7 +173279,24 @@ "desc" : "Fetch the element to display the tooltip on.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.Component" + "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" : "un", @@ -67443,7 +173304,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -67542,14 +173433,7 @@ "name" : "region", "type" : "String", "desc" : "t) which region to put this panel on (when used with xtype constructors)", - "memberOf" : "", - "optvals" : [ - "center", - "north", - "south", - "east", - "west" - ] + "memberOf" : "" }, { "name" : "resizeEl", @@ -67582,35 +173466,118 @@ "type" : "function", "desc" : "Fires when this panel is activated.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "deactivate", "type" : "function", "desc" : "Fires when this panel is activated.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires when this tab is created", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires when this panel is resized if fitToFrame is true.", "sig" : "function (_self, width, height)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The width after any component adjustments", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The height after any component adjustments", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "scroll", "type" : "function", "desc" : "Fires when this content is scrolled", "sig" : "function (_self, scrollEvent)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scrollEvent", + "type" : "Event", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -67620,7 +173587,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -67628,7 +173613,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -67636,7 +173657,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -67644,7 +173695,18 @@ "desc" : "Destroys this panel", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -67652,7 +173714,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getChildContainer", @@ -67660,7 +173752,25 @@ "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n
\n\nlayout.addxtype({\n       xtype : 'Form',\n       items: [ .... ]\n   }\n);\n\n
", "sig" : "(cfg)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cfg", + "type" : "Object", + "desc" : "Xtype definition of item to add.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -67668,7 +173778,24 @@ "desc" : "Returns this panel's element - used by regiosn to add.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] }, { "name" : "getId", @@ -67676,7 +173803,24 @@ "desc" : "Returns this panel's id", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getTitle", @@ -67684,7 +173828,24 @@ "desc" : "Returns this panel's title", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getToolbar", @@ -67692,7 +173853,24 @@ "desc" : "Returns the toolbar for this Panel if one was configured.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar", + "desc" : "" + } + ] }, { "name" : "getUpdateManager", @@ -67700,7 +173878,24 @@ "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] }, { "name" : "hasListener", @@ -67708,7 +173903,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "isClosable", @@ -67716,7 +173935,24 @@ "desc" : "Returns true is this panel was configured to be closable", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "load", @@ -67724,7 +173960,49 @@ "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents", "sig" : "(url, params, callback, discardUrl)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "url", + "type" : "Object/String/Function", + "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n
\npanel.load({\n    url: \"your-url.php\",\n    params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n    callback: yourFunction,\n    scope: yourObject, //(optional scope)\n    discardUrl: false,\n    nocache: false,\n    text: \"Loading...\",\n    timeout: 30,\n    scripts: false\n});\n
\nThe only required property is url. The optional properties nocache, text and scripts\nare shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this panel UpdateManager instance.", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)", + "isOptional" : false + }, + { + "name" : "discardUrl", + "type" : "Boolean", + "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "this" + } + ] }, { "name" : "on", @@ -67732,7 +174010,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -67740,7 +174054,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "refresh", @@ -67748,7 +174073,18 @@ "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -67756,7 +174092,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -67764,7 +174118,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "setContent", @@ -67772,7 +174156,31 @@ "desc" : "Updates this panel's element (not for iframe)", "sig" : "(content, loadScripts)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "content", + "type" : "String", + "desc" : "The new content", + "isOptional" : false + }, + { + "name" : "loadScripts", + "type" : "Boolean", + "desc" : "(optional) true to look for and process scripts", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setTitle", @@ -67780,7 +174188,25 @@ "desc" : "Set this panel's title", "sig" : "(title)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setUrl", @@ -67788,7 +174214,43 @@ "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.", "sig" : "(url, params, loadOnce)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "url", + "type" : "String/Function", + "desc" : "The URL to load the content from or a function to call to get the URL", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)", + "isOptional" : false + }, + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager|Boolean", + "desc" : "The UpdateManager or false if IFRAME" + } + ] }, { "name" : "un", @@ -67796,7 +174258,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -67896,14 +174388,7 @@ "name" : "region", "type" : "String", "desc" : "t) which region to put this panel on (when used with xtype constructors)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [ - "center", - "north", - "south", - "east", - "west" - ] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "resizeEl", @@ -67936,35 +174421,118 @@ "type" : "function", "desc" : "Fires when this panel is activated.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "deactivate", "type" : "function", "desc" : "Fires when this panel is activated.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires when this tab is created", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires when this panel is resized if fitToFrame is true.", "sig" : "function (_self, width, height)\n{\n\n}", - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The width after any component adjustments", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The height after any component adjustments", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "scroll", "type" : "function", "desc" : "Fires when this content is scrolled", "sig" : "function (_self, scrollEvent)\n{\n\n}", - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scrollEvent", + "type" : "Event", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -67974,7 +174542,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -67982,7 +174568,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -67990,7 +174612,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -67998,7 +174650,18 @@ "desc" : "Destroys this panel", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -68006,7 +174669,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getChildContainer", @@ -68014,7 +174707,25 @@ "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n
\n\nlayout.addxtype({\n       xtype : 'Form',\n       items: [ .... ]\n   }\n);\n\n
", "sig" : "(cfg)", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cfg", + "type" : "Object", + "desc" : "Xtype definition of item to add.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -68022,7 +174733,24 @@ "desc" : "Returns this panel's element - used by regiosn to add.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] }, { "name" : "getGrid", @@ -68030,7 +174758,24 @@ "desc" : "Returns the grid for this panel", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.bootstrap.Table", + "desc" : "" + } + ] }, { "name" : "getId", @@ -68038,7 +174783,24 @@ "desc" : "Returns this panel's id", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getTitle", @@ -68046,7 +174808,24 @@ "desc" : "Returns this panel's title", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getToolbar", @@ -68054,7 +174833,24 @@ "desc" : "Returns the toolbar for this Panel if one was configured.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar", + "desc" : "" + } + ] }, { "name" : "getUpdateManager", @@ -68062,7 +174858,24 @@ "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] }, { "name" : "hasListener", @@ -68070,7 +174883,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "isClosable", @@ -68078,7 +174915,24 @@ "desc" : "Returns true is this panel was configured to be closable", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "load", @@ -68086,7 +174940,49 @@ "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents", "sig" : "(url, params, callback, discardUrl)", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "url", + "type" : "Object/String/Function", + "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n
\npanel.load({\n    url: \"your-url.php\",\n    params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n    callback: yourFunction,\n    scope: yourObject, //(optional scope)\n    discardUrl: false,\n    nocache: false,\n    text: \"Loading...\",\n    timeout: 30,\n    scripts: false\n});\n
\nThe only required property is url. The optional properties nocache, text and scripts\nare shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this panel UpdateManager instance.", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)", + "isOptional" : false + }, + { + "name" : "discardUrl", + "type" : "Boolean", + "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "this" + } + ] }, { "name" : "on", @@ -68094,7 +174990,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -68102,7 +175034,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "refresh", @@ -68110,7 +175053,18 @@ "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -68118,7 +175072,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -68126,7 +175098,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "setContent", @@ -68134,7 +175136,31 @@ "desc" : "Updates this panel's element (not for iframe)", "sig" : "(content, loadScripts)", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "content", + "type" : "String", + "desc" : "The new content", + "isOptional" : false + }, + { + "name" : "loadScripts", + "type" : "Boolean", + "desc" : "(optional) true to look for and process scripts", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setTitle", @@ -68142,7 +175168,25 @@ "desc" : "Set this panel's title", "sig" : "(title)", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setUrl", @@ -68150,7 +175194,43 @@ "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.", "sig" : "(url, params, loadOnce)", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "url", + "type" : "String/Function", + "desc" : "The URL to load the content from or a function to call to get the URL", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)", + "isOptional" : false + }, + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager|Boolean", + "desc" : "The UpdateManager or false if IFRAME" + } + ] }, { "name" : "un", @@ -68158,7 +175238,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -68252,14 +175362,7 @@ "name" : "region", "type" : "String", "desc" : "t) which region to put this panel on (when used with xtype constructors)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [ - "center", - "north", - "south", - "east", - "west" - ] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "resizeEl", @@ -68292,35 +175395,118 @@ "type" : "function", "desc" : "Fires when this panel is activated.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "deactivate", "type" : "function", "desc" : "Fires when this panel is activated.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires when this tab is created", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires when this panel is resized if fitToFrame is true.", "sig" : "function (_self, width, height)\n{\n\n}", - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The width after any component adjustments", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The height after any component adjustments", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "scroll", "type" : "function", "desc" : "Fires when this content is scrolled", "sig" : "function (_self, scrollEvent)\n{\n\n}", - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.ContentPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scrollEvent", + "type" : "Event", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -68330,7 +175516,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -68338,7 +175542,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "addxtype", @@ -68346,7 +175586,25 @@ "desc" : "Adds a xtype elements to the layout of the nested panel\n
\n\npanel.addxtype({\n       xtype : 'ContentPanel',\n       region: 'west',\n       items: [ .... ]\n   }\n);\n\npanel.addxtype({\n        xtype : 'NestedLayoutPanel',\n        region: 'west',\n        layout: {\n           center: { },\n           west: { }   \n        },\n        items : [ ... list of content panels or nested layout panels.. ]\n   }\n);\n
", "sig" : "(cfg)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cfg", + "type" : "Object", + "desc" : "Xtype definition of item to add.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "capture", @@ -68354,7 +175612,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -68362,7 +175650,18 @@ "desc" : "Destroys this panel", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -68370,7 +175669,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getChildContainer", @@ -68378,7 +175707,25 @@ "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n
\n\nlayout.addxtype({\n       xtype : 'Form',\n       items: [ .... ]\n   }\n);\n\n
", "sig" : "(cfg)", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cfg", + "type" : "Object", + "desc" : "Xtype definition of item to add.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -68386,7 +175733,24 @@ "desc" : "Returns this panel's element - used by regiosn to add.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "" + } + ] }, { "name" : "getId", @@ -68394,7 +175758,24 @@ "desc" : "Returns this panel's id", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getLayout", @@ -68402,7 +175783,24 @@ "desc" : "Returns the nested BorderLayout for this panel", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.BorderLayout", + "desc" : "" + } + ] }, { "name" : "getTitle", @@ -68410,7 +175808,24 @@ "desc" : "Returns this panel's title", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getToolbar", @@ -68418,7 +175833,24 @@ "desc" : "Returns the toolbar for this Panel if one was configured.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Toolbar", + "desc" : "" + } + ] }, { "name" : "getUpdateManager", @@ -68426,7 +175858,24 @@ "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] }, { "name" : "hasListener", @@ -68434,7 +175883,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "isClosable", @@ -68442,7 +175915,24 @@ "desc" : "Returns true is this panel was configured to be closable", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "load", @@ -68450,7 +175940,49 @@ "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents", "sig" : "(url, params, callback, discardUrl)", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "url", + "type" : "Object/String/Function", + "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n
\npanel.load({\n    url: \"your-url.php\",\n    params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n    callback: yourFunction,\n    scope: yourObject, //(optional scope)\n    discardUrl: false,\n    nocache: false,\n    text: \"Loading...\",\n    timeout: 30,\n    scripts: false\n});\n
\nThe only required property is url. The optional properties nocache, text and scripts\nare shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this panel UpdateManager instance.", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)", + "isOptional" : false + }, + { + "name" : "discardUrl", + "type" : "Boolean", + "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.ContentPanel", + "desc" : "this" + } + ] }, { "name" : "on", @@ -68458,7 +175990,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -68466,7 +176034,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "refresh", @@ -68474,7 +176053,18 @@ "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -68482,7 +176072,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -68490,7 +176098,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "setContent", @@ -68498,7 +176136,31 @@ "desc" : "Updates this panel's element (not for iframe)", "sig" : "(content, loadScripts)", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "content", + "type" : "String", + "desc" : "The new content", + "isOptional" : false + }, + { + "name" : "loadScripts", + "type" : "Boolean", + "desc" : "(optional) true to look for and process scripts", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setTitle", @@ -68506,7 +176168,25 @@ "desc" : "Set this panel's title", "sig" : "(title)", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "title", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setUrl", @@ -68514,7 +176194,43 @@ "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.", "sig" : "(url, params, loadOnce)", "static" : false, - "memberOf" : "Roo.bootstrap.panel.Content" + "memberOf" : "Roo.bootstrap.panel.Content", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "url", + "type" : "String/Function", + "desc" : "The URL to load the content from or a function to call to get the URL", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)", + "isOptional" : false + }, + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager|Boolean", + "desc" : "The UpdateManager or false if IFRAME" + } + ] }, { "name" : "un", @@ -68522,7 +176238,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -68541,28 +176287,98 @@ "type" : "function", "desc" : "Fires when this tab becomes the active tab.", "sig" : "function (tabPanel, _self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tabPanel", + "type" : "Roo.TabPanel", + "desc" : "The parent TabPanel", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Roo.TabPanelItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeclose", "type" : "function", "desc" : "Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true).", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.TabPanelItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "Set cancel to true on this object to cancel the close.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "close", "type" : "function", "desc" : "Fires when this tab is closed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.TabPanelItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "deactivate", "type" : "function", "desc" : "Fires when this tab is no longer the active tab.", "sig" : "function (tabPanel, _self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tabPanel", + "type" : "Roo.TabPanel", + "desc" : "The parent TabPanel", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Roo.TabPanelItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -68572,7 +176388,18 @@ "desc" : "Activates this TabPanelItem -- this does deactivate the currently active TabPanelItem.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "addEvents", @@ -68580,7 +176407,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -68588,7 +176433,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -68596,7 +176477,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "disable", @@ -68604,7 +176515,18 @@ "desc" : "Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "enable", @@ -68612,7 +176534,18 @@ "desc" : "Enables this TabPanelItem if it was previously disabled.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -68620,7 +176553,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getText", @@ -68628,7 +176591,24 @@ "desc" : "Returns the text for this tab", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getUpdateManager", @@ -68636,7 +176616,24 @@ "desc" : "Gets the {@link Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] }, { "name" : "hasListener", @@ -68644,7 +176641,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -68652,7 +176673,18 @@ "desc" : "Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isActive", @@ -68660,7 +176692,24 @@ "desc" : "Returns true if this tab is the active tab.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isHidden", @@ -68668,7 +176717,24 @@ "desc" : "Returns true if this tab is \"hidden\"", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "on", @@ -68676,7 +176742,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -68684,7 +176786,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "refresh", @@ -68692,7 +176805,18 @@ "desc" : "Forces a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the setUrl method has not been called.\n This does not activate the panel, just updates its content.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -68700,7 +176824,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -68708,7 +176850,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "setContent", @@ -68716,7 +176888,31 @@ "desc" : "Sets the content for this TabPanelItem.", "sig" : "(content, loadScripts)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "content", + "type" : "String", + "desc" : "The content", + "isOptional" : false + }, + { + "name" : "loadScripts", + "type" : "Boolean", + "desc" : "true to look for and load scripts", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setHidden", @@ -68724,7 +176920,25 @@ "desc" : "Show or hide the tab", "sig" : "(hidden)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True to hide or false to show.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setText", @@ -68732,7 +176946,25 @@ "desc" : "Sets the text for the tab (Note: this also sets the tooltip text)", "sig" : "(text)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The tab's text and tooltip", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setTooltip", @@ -68740,7 +176972,25 @@ "desc" : "Set the tooltip for the tab.", "sig" : "(tooltip)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "tooltip", + "type" : "String", + "desc" : "The tab's tooltip", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setUrl", @@ -68748,7 +176998,43 @@ "desc" : "Set a URL to be used to load the content for this TabPanelItem.", "sig" : "(url, params, loadOnce)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "url", + "type" : "String/Function", + "desc" : "The URL to load the content from, or a function to call to get the URL", + "isOptional" : false + }, + { + "name" : "params", + "type" : "String/Object", + "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)", + "isOptional" : false + }, + { + "name" : "loadOnce", + "type" : "Boolean", + "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this TabPanelItem is activated. (Defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.UpdateManager", + "desc" : "The UpdateManager" + } + ] }, { "name" : "show", @@ -68756,7 +177042,18 @@ "desc" : "Shows this TabPanelItem -- this does not deactivate the currently active TabPanelItem.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -68764,7 +177061,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -68783,14 +177110,58 @@ "type" : "function", "desc" : "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change", "sig" : "function (_self, e, tab)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.TabPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "Set cancel to true on this object to cancel the tab change", + "isOptional" : false + }, + { + "name" : "tab", + "type" : "Roo.TabPanelItem", + "desc" : "The tab being changed to", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "tabchange", "type" : "function", "desc" : "Fires when the active tab changes", "sig" : "function (_self, activePanel)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.TabPanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "activePanel", + "type" : "Roo.TabPanelItem", + "desc" : "The new active tab", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -68800,7 +177171,31 @@ "desc" : "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated.", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to activate.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanelItem", + "desc" : "The TabPanelItem." + } + ] }, { "name" : "addEvents", @@ -68808,7 +177203,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -68816,7 +177229,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "addTab", @@ -68824,7 +177273,49 @@ "desc" : "Creates a new {@link Roo.TabPanelItem} by looking for an existing element with the provided id -- if it's not found it creates one.", "sig" : "(id, text, content, closable)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id of the div to use or create", + "isOptional" : false + }, + { + "name" : "text", + "type" : "String", + "desc" : "The text for the tab", + "isOptional" : false + }, + { + "name" : "content", + "type" : "String", + "desc" : "(optional) Content to put in the TabPanelItem body", + "isOptional" : false + }, + { + "name" : "closable", + "type" : "Boolean", + "desc" : "(optional) True to create a close icon on the tab", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanelItem", + "desc" : "The created TabPanelItem" + } + ] }, { "name" : "addTabItem", @@ -68832,7 +177323,25 @@ "desc" : "Adds an existing {@link Roo.TabPanelItem}.", "sig" : "(item)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "item", + "type" : "Roo.TabPanelItem", + "desc" : "The TabPanelItem to add", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "autoSizeTabs", @@ -68840,7 +177349,18 @@ "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "beginUpdate", @@ -68848,7 +177368,18 @@ "desc" : "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -68856,7 +177387,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -68864,7 +177425,25 @@ "desc" : "Destroys this TabPanel", "sig" : "(removeEl)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "removeEl", + "type" : "Boolean", + "desc" : "(optional) True to remove the element from the DOM as well (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "disableTab", @@ -68872,7 +177451,25 @@ "desc" : "Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored.", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to disable.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enableTab", @@ -68880,7 +177477,25 @@ "desc" : "Enables a {@link Roo.TabPanelItem} that is disabled.", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to enable.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "endUpdate", @@ -68888,7 +177503,18 @@ "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -68896,7 +177522,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getActiveTab", @@ -68904,7 +177560,24 @@ "desc" : "Gets the active {@link Roo.TabPanelItem}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanelItem", + "desc" : "The active TabPanelItem or null if none are active." + } + ] }, { "name" : "getCount", @@ -68912,7 +177585,24 @@ "desc" : "Returns the number of tabs in this TabPanel.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] }, { "name" : "getTab", @@ -68920,7 +177610,31 @@ "desc" : "Returns the {@link Roo.TabPanelItem} with the specified id/index", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to fetch.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.TabPanelItem", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -68928,7 +177642,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hideTab", @@ -68936,7 +177674,25 @@ "desc" : "Hides the {@link Roo.TabPanelItem} with the specified id/index", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to hide.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -68944,7 +177700,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -68952,7 +177744,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -68960,7 +177763,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -68968,7 +177789,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "removeTab", @@ -68976,7 +177827,25 @@ "desc" : "Removes a {@link Roo.TabPanelItem}.", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to remove.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setTabWidth", @@ -68984,7 +177853,25 @@ "desc" : "Resizes all the tabs to the passed width", "sig" : "(The)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "The", + "type" : "Number", + "desc" : "new width", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "syncHeight", @@ -68992,7 +177879,25 @@ "desc" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling", "sig" : "(targetHeight)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "targetHeight", + "type" : "Number", + "desc" : "(optional) Override the starting height from the elements height", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "un", @@ -69000,7 +177905,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "unhideTab", @@ -69008,7 +177943,25 @@ "desc" : "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index.", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String/Number", + "desc" : "The id or index of the TabPanelItem to unhide.", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -69040,7 +177993,31 @@ "desc" : "Create an empty record", "sig" : "(data)", "static" : false, - "memberOf" : "Roo.data.DataReader" + "memberOf" : "Roo.data.DataReader", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "data", + "type" : "Object", + "desc" : "(optional) - overlay some values", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record", + "desc" : "record created." + } + ] }, { "name" : "readRecords", @@ -69048,7 +178025,31 @@ "desc" : "Create a data block containing Roo.data.Records from an XML document.", "sig" : "(o)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "o", + "type" : "Object", + "desc" : "An Array of row objects which represents the dataset.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "A data block which is used by an {@link Roo.data.Store} object as\na cache of Roo.data.Records." + } + ] } ] }, @@ -69109,21 +178110,90 @@ "type" : "function", "desc" : "Fires before a network request is made to retrieve a data object.", "sig" : "function (conn, options)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "conn", + "type" : "Connection", + "desc" : "This Connection object.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The options config object passed to the {@link #request} method.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "requestcomplete", "type" : "function", "desc" : "Fires if the request was successfully completed.", "sig" : "function (conn, response, options)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "conn", + "type" : "Connection", + "desc" : "This Connection object.", + "isOptional" : false + }, + { + "name" : "response", + "type" : "Object", + "desc" : "The XHR object containing the response data.\nSee {@link http://www.w3.org/TR/XMLHttpRequest/} for details.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The options config object passed to the {@link #request} method.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "requestexception", "type" : "function", "desc" : "Fires if an error HTTP status was returned from the server.\nSee {@link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html} for details of HTTP status codes.", "sig" : "function (conn, response, options)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "conn", + "type" : "Connection", + "desc" : "This Connection object.", + "isOptional" : false + }, + { + "name" : "response", + "type" : "Object", + "desc" : "The XHR object containing the response data.\nSee {@link http://www.w3.org/TR/XMLHttpRequest/} for details.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The options config object passed to the {@link #request} method.", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -69133,7 +178203,25 @@ "desc" : "Aborts any outstanding request.", "sig" : "(transactionId)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "transactionId", + "type" : "Number", + "desc" : "(Optional) defaults to the last transaction", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addEvents", @@ -69141,7 +178229,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -69149,7 +178255,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -69157,7 +178299,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "fireEvent", @@ -69165,7 +178337,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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", @@ -69173,7 +178375,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "isLoading", @@ -69181,7 +178407,31 @@ "desc" : "Determine whether this object has a request outstanding.", "sig" : "(transactionId)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "transactionId", + "type" : "Number", + "desc" : "(Optional) defaults to the last transaction", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if there is an outstanding request." + } + ] }, { "name" : "on", @@ -69189,7 +178439,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -69197,7 +178483,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -69205,7 +178502,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -69213,7 +178528,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "request", @@ -69221,7 +178566,31 @@ "desc" : "Sends an HTTP request to a remote server.", "sig" : "(options)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "An object which may contain the following properties:", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "transactionId" + } + ] }, { "name" : "un", @@ -69229,7 +178598,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -69241,21 +178640,96 @@ "type" : "function", "desc" : "Fires before a network request is made to retrieve a data object.", "sig" : "function (This, params)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "This", + "type" : "Object", + "desc" : "DataProxy object.", + "isOptional" : false + }, + { + "name" : "params", + "type" : "Object", + "desc" : "The params parameter to the load function.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "load", "type" : "function", "desc" : "Fires before the load method's callback is called.", "sig" : "function (This, o, arg)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "This", + "type" : "Object", + "desc" : "DataProxy object.", + "isOptional" : false + }, + { + "name" : "o", + "type" : "Object", + "desc" : "The data object.", + "isOptional" : false + }, + { + "name" : "arg", + "type" : "Object", + "desc" : "The callback argument object passed to the load function.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "loadexception", "type" : "function", "desc" : "Fires if an Exception occurs during data retrieval.", "sig" : "function (This, o, arg, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "This", + "type" : "Object", + "desc" : "DataProxy object.", + "isOptional" : false + }, + { + "name" : "o", + "type" : "Object", + "desc" : "The data object.", + "isOptional" : false + }, + { + "name" : "arg", + "type" : "Object", + "desc" : "The callback argument object passed to the load function.", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "The Exception.", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [] @@ -69270,7 +178744,31 @@ "desc" : "Create an empty record", "sig" : "(data)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "data", + "type" : "Object", + "desc" : "(optional) - overlay some values", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record", + "desc" : "record created." + } + ] } ] }, @@ -69325,21 +178823,96 @@ "type" : "function", "desc" : "Fires before a network request is made to retrieve a data object.", "sig" : "function (This, params)\n{\n\n}", - "memberOf" : "Roo.data.DataProxy" + "memberOf" : "Roo.data.DataProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "This", + "type" : "Object", + "desc" : "DataProxy object.", + "isOptional" : false + }, + { + "name" : "params", + "type" : "Object", + "desc" : "The params parameter to the load function.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "load", "type" : "function", "desc" : "Fires before the load method's callback is called.", "sig" : "function (This, o, arg)\n{\n\n}", - "memberOf" : "Roo.data.DataProxy" + "memberOf" : "Roo.data.DataProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "This", + "type" : "Object", + "desc" : "DataProxy object.", + "isOptional" : false + }, + { + "name" : "o", + "type" : "Object", + "desc" : "The data object.", + "isOptional" : false + }, + { + "name" : "arg", + "type" : "Object", + "desc" : "The callback argument object passed to the load function.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "loadexception", "type" : "function", "desc" : "Fires if an Exception occurs during data retrieval.", "sig" : "function (This, o, arg, e)\n{\n\n}", - "memberOf" : "Roo.data.DataProxy" + "memberOf" : "Roo.data.DataProxy", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "This", + "type" : "Object", + "desc" : "DataProxy object.", + "isOptional" : false + }, + { + "name" : "o", + "type" : "Object", + "desc" : "The data object.", + "isOptional" : false + }, + { + "name" : "arg", + "type" : "Object", + "desc" : "The callback argument object passed to the load function.", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "The Exception.", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -69349,7 +178922,24 @@ "desc" : "Return the {@link Roo.data.Connection} object being used by this Proxy.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Connection", + "desc" : "The Connection object. This object may be used to subscribe to events on\na finer-grained basis than the DataProxy events." + } + ] }, { "name" : "load", @@ -69357,7 +178947,49 @@ "desc" : "Load data from the configured {@link Roo.data.Connection}, read the data object into\na block of Roo.data.Records using the passed {@link Roo.data.DataReader} implementation, and\nprocess that block using the passed callback.", "sig" : "(params, reader, callback, scope, arg)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "params", + "type" : "Object", + "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.", + "isOptional" : false + }, + { + "name" : "reader", + "type" : "Roo.data.DataReader", + "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "The function into which to pass the block of Roo.data.Records.\nThe function must be passed ", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "The scope in which to call the callback", + "isOptional" : false + }, + { + "name" : "arg", + "type" : "Object", + "desc" : "An optional argument which is passed to the callback as its second parameter.", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -69402,7 +179034,31 @@ "desc" : "Create an empty record", "sig" : "(data)", "static" : false, - "memberOf" : "Roo.data.DataReader" + "memberOf" : "Roo.data.DataReader", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "data", + "type" : "Object", + "desc" : "(optional) - overlay some values", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record", + "desc" : "record created." + } + ] }, { "name" : "read", @@ -69410,7 +179066,31 @@ "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.", "sig" : "(response)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "response", + "type" : "Object", + "desc" : "The XHR object which contains the JSON data in its responseText.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "data A data block which is used by an Roo.data.Store object as\na cache of Roo.data.Records." + } + ] }, { "name" : "readRecords", @@ -69418,7 +179098,31 @@ "desc" : "Create a data block containing Roo.data.Records from an XML document.", "sig" : "(o)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "o", + "type" : "Object", + "desc" : "An object which contains an Array of row objects in the property specified\nin the config as 'root, and optionally a property, specified in the config as 'totalProperty'\nwhich contains the total size of the dataset.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "data A data block which is used by an Roo.data.Store object as\na cache of Roo.data.Records." + } + ] } ] }, @@ -69463,7 +179167,7 @@ { "name" : "proxy", "type" : "Roo.data.DataProxy", - "desc" : "The Proxy object which provides access to a data object.", + "desc" : "[required] The Proxy object which provides access to a data object.", "memberOf" : "Roo.data.Store" }, { @@ -69474,8 +179178,8 @@ }, { "name" : "reader", - "type" : "Roo.data.Reader", - "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their id property.", + "type" : "Roo.data.DataReader", + "desc" : "[required] The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their id property.", "memberOf" : "Roo.data.Store" }, { @@ -69497,70 +179201,290 @@ "type" : "function", "desc" : "Fires when Records have been added to the Store", "sig" : "function (_self, records, index)\n{\n\n}", - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "The array of Records added", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index at which the record(s) were added", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeload", "type" : "function", "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.", "sig" : "function (_self, options)\n{\n\n}", - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The loading options that were specified (see {@link #load} for details)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeloadadd", "type" : "function", "desc" : "Fires after a new set of Records has been loaded.", "sig" : "function (_self, records, options)\n{\n\n}", - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "The Records that were loaded", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The loading options that were specified (see {@link #load} for details)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "clear", "type" : "function", "desc" : "Fires when the data cache has been cleared.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "datachanged", "type" : "function", "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "load", "type" : "function", "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.", "sig" : "function (_self, records, options)\n{\n\n}", - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "The Records that were loaded", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The loading options that were specified (see {@link #load} for details)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "loadexception", "type" : "function", "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args", "sig" : "function (, return, load, jsonData)\n{\n\n}", - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "", + "type" : "Proxy", + "desc" : "", + "isOptional" : false + }, + { + "name" : "return", + "type" : "Object", + "desc" : "from JsonData.reader() - success, totalRecords, records", + "isOptional" : false + }, + { + "name" : "load", + "type" : "Object", + "desc" : "options", + "isOptional" : false + }, + { + "name" : "jsonData", + "type" : "Object", + "desc" : "from your request (normally this contains the Exception)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "metachange", "type" : "function", "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.", "sig" : "function (_self, meta)\n{\n\n}", - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "meta", + "type" : "Object", + "desc" : "The JSON metadata", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "remove", "type" : "function", "desc" : "Fires when a Record has been removed from the Store", "sig" : "function (_self, record, index)\n{\n\n}", - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The Record that was removed", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index at which the record was removed", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "update", "type" : "function", "desc" : "Fires when a Record has been updated", "sig" : "function (_self, record, operation)\n{\n\n}", - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The Record that was updated", + "isOptional" : false + }, + { + "name" : "operation", + "type" : "String", + "desc" : "The update operation being performed. Value may be one of:\n
\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n
", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -69570,7 +179494,25 @@ "desc" : "Add Records to the Store and fires the add event.", "sig" : "(records)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "An Array of Roo.data.Record objects to add to the cache.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addEvents", @@ -69578,7 +179520,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -69586,7 +179546,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -69594,7 +179590,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearFilter", @@ -69602,7 +179628,25 @@ "desc" : "Revert to a view of the Record cache with no filtering applied.", "sig" : "(suppressEvent)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "suppressEvent", + "type" : "Boolean", + "desc" : "If true the filter is cleared silently without notifying listeners", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "collect", @@ -69610,7 +179654,43 @@ "desc" : "Collects unique values for a particular dataIndex from this store.", "sig" : "(dataIndex, allowNull, bypassFilter)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "dataIndex", + "type" : "String", + "desc" : "The property to collect", + "isOptional" : false + }, + { + "name" : "allowNull", + "type" : "Boolean", + "desc" : "(optional) Pass true to allow null, undefined or empty string values", + "isOptional" : false + }, + { + "name" : "bypassFilter", + "type" : "Boolean", + "desc" : "(optional) Pass true to collect from all records, even ones which are filtered", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "An array of the unique values" + } + ] }, { "name" : "commitChanges", @@ -69618,7 +179698,18 @@ "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "each", @@ -69626,7 +179717,31 @@ "desc" : "Calls the specified function for each of the Records in the cache.", "sig" : "(fn, scope)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call. The Record is passed as the first parameter.\nReturning false aborts and exits the iteration.", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to call the function (defaults to the Record).", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "filter", @@ -69634,7 +179749,37 @@ "desc" : "Filter the records by a specified property.", "sig" : "(field, value, anyMatch)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "field", + "type" : "String", + "desc" : "A field on your records", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String/RegExp", + "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field", + "isOptional" : false + }, + { + "name" : "anyMatch", + "type" : "Boolean", + "desc" : "True to match any part not just the beginning", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "filterBy", @@ -69642,7 +179787,31 @@ "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.", "sig" : "(fn, scope)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to be called, it will receive 2 args (record, id)", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to this)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -69650,7 +179819,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getAt", @@ -69658,7 +179857,31 @@ "desc" : "Get the Record at the specified index.", "sig" : "(index)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the Record to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record", + "desc" : "The Record at the passed index. Returns undefined if not found." + } + ] }, { "name" : "getById", @@ -69666,7 +179889,31 @@ "desc" : "Get the Record with the specified id.", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id of the Record to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record", + "desc" : "The Record with the passed id. Returns undefined if not found." + } + ] }, { "name" : "getCount", @@ -69674,7 +179921,18 @@ "desc" : "Gets the number of cached records.\n

\nIf using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "getModifiedRecords", @@ -69682,7 +179940,24 @@ "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record[]", + "desc" : "An array of Records containing outstanding modifications." + } + ] }, { "name" : "getRange", @@ -69690,7 +179965,37 @@ "desc" : "Returns a range of Records between specified indices.", "sig" : "(startIndex, endIndex)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "startIndex", + "type" : "Number", + "desc" : "(optional) The starting index (defaults to 0)", + "isOptional" : false + }, + { + "name" : "endIndex", + "type" : "Number", + "desc" : "(optional) The ending index (defaults to the last Record in the Store)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record[]", + "desc" : "An array of Records" + } + ] }, { "name" : "getSortState", @@ -69698,7 +180003,18 @@ "desc" : "Returns the sort state of the Store as an object with two properties:\n

\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n
", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "getTotalCount", @@ -69706,7 +180022,18 @@ "desc" : "Gets the total number of records in the dataset as returned by the server.\n

\nIf using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -69714,7 +180041,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "indexOf", @@ -69722,7 +180073,31 @@ "desc" : "Get the index within the cache of the passed Record.", "sig" : "(record)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The Roo.data.Record object to to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The index of the passed Record. Returns -1 if not found." + } + ] }, { "name" : "indexOfId", @@ -69730,7 +180105,31 @@ "desc" : "Get the index within the cache of the Record with the passed id.", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id of the Record to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The index of the Record. Returns -1 if not found." + } + ] }, { "name" : "insert", @@ -69738,7 +180137,31 @@ "desc" : "Inserts Records to the Store at the given index and fires the add event.", "sig" : "(index, records)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The start index at which to insert the passed Records.", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "An Array of Roo.data.Record objects to add to the cache.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "load", @@ -69746,7 +180169,25 @@ "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n

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

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

", "sig" : "(options)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "An object containing properties which control loading options:

", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "loadData", @@ -69754,7 +180195,31 @@ "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.", "sig" : "(data, append)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "data", + "type" : "Object", + "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.", + "isOptional" : false + }, + { + "name" : "append", + "type" : "Boolean", + "desc" : "(Optional) True to append the new Records rather than replace the existing cache.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "loadDataFromChildren", @@ -69762,7 +180227,25 @@ "desc" : "using 'cn' the nested child reader read the child array into it's child stores.", "sig" : "(rec)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "rec", + "type" : "Object", + "desc" : "The record with a 'children array", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -69770,7 +180253,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -69778,7 +180297,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "query", @@ -69786,7 +180316,43 @@ "desc" : "Query the records by a specified property.", "sig" : "(field, value, anyMatch)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "field", + "type" : "String", + "desc" : "A field on your records", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String/RegExp", + "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field", + "isOptional" : false + }, + { + "name" : "anyMatch", + "type" : "Boolean", + "desc" : "True to match any part not just the beginning", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "MixedCollection", + "desc" : "Returns an Roo.util.MixedCollection of the matched records" + } + ] }, { "name" : "queryBy", @@ -69794,7 +180360,37 @@ "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.", "sig" : "(fn, scope)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to be called, it will receive 2 args (record, id)", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to this)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "MixedCollection", + "desc" : "Returns an Roo.util.MixedCollection of the matched records" + } + ] }, { "name" : "rejectChanges", @@ -69802,7 +180398,18 @@ "desc" : "Cancel outstanding changes on all changed records.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -69810,7 +180417,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "reload", @@ -69818,7 +180443,25 @@ "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.", "sig" : "(options)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "remove", @@ -69826,7 +180469,25 @@ "desc" : "Remove a Record from the Store and fires the remove event.", "sig" : "(record)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "record", + "type" : "Ext.data.Record", + "desc" : "The Roo.data.Record object to remove from the cache.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeAll", @@ -69834,7 +180495,18 @@ "desc" : "Remove all Records from the Store and fires the clear event.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "removeListener", @@ -69842,7 +180514,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "setDefaultSort", @@ -69850,7 +180552,31 @@ "desc" : "Sets the default sort column and order to be used by the next load operation.", "sig" : "(fieldName, dir)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fieldName", + "type" : "String", + "desc" : "The name of the field to sort by.", + "isOptional" : false + }, + { + "name" : "dir", + "type" : "String", + "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "sort", @@ -69858,7 +180584,31 @@ "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.", "sig" : "(fieldName, dir)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fieldName", + "type" : "String", + "desc" : "The name of the field to sort by.", + "isOptional" : false + }, + { + "name" : "dir", + "type" : "String", + "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "sum", @@ -69866,7 +180616,43 @@ "desc" : "Sums the value of property for each record between start and end and returns the result.", "sig" : "(property, start, end)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "property", + "type" : "String", + "desc" : "A field on your records", + "isOptional" : false + }, + { + "name" : "start", + "type" : "Number", + "desc" : "The record index to start at (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "The last record index to include (defaults to length - 1)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The sum" + } + ] }, { "name" : "un", @@ -69874,7 +180660,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -69888,7 +180704,49 @@ "desc" : "Load data from the requested source (in this case an in-memory\ndata object passed to the constructor), read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.", "sig" : "(params, reader, callback, scope, arg)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "params", + "type" : "Object", + "desc" : "This parameter is not used by the MemoryProxy class.", + "isOptional" : false + }, + { + "name" : "reader", + "type" : "Roo.data.DataReader", + "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "The function into which to pass the block of Roo.data.records.\nThe function must be passed ", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "The scope in which to call the callback", + "isOptional" : false + }, + { + "name" : "arg", + "type" : "Object", + "desc" : "An optional argument which is passed to the callback as its second parameter.", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -69919,56 +180777,298 @@ "type" : "function", "desc" : "Fires when a new child node is appended", "sig" : "function (tree, _self, node, index)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The newly appended node", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the newly appended node", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeappend", "type" : "function", "desc" : "Fires before a new child is appended, return false to cancel the append.", "sig" : "function (tree, _self, node)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be appended", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeinsert", "type" : "function", "desc" : "Fires before a new child is inserted, return false to cancel the insert.", "sig" : "function (tree, _self, node, refNode)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be inserted", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The child node the node is being inserted before", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforemove", "type" : "function", "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.", "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "oldParent", + "type" : "Node", + "desc" : "The parent of this node", + "isOptional" : false + }, + { + "name" : "newParent", + "type" : "Node", + "desc" : "The new parent this node is moving to", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index it is being moved to", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeremove", "type" : "function", "desc" : "Fires before a child is removed, return false to cancel the remove.", "sig" : "function (tree, _self, node)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be removed", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "insert", "type" : "function", "desc" : "Fires when a new child node is inserted.", "sig" : "function (tree, _self, node, refNode)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node inserted", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The child node the node was inserted before", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires when this node is moved to a new location in the tree", "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "oldParent", + "type" : "Node", + "desc" : "The old parent of this node", + "isOptional" : false + }, + { + "name" : "newParent", + "type" : "Node", + "desc" : "The new parent of this node", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index it was moved to", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "remove", "type" : "function", "desc" : "Fires when a child node is removed", "sig" : "function (tree, _self, node)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The removed node", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -69978,7 +181078,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -69986,7 +181104,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "appendChild", @@ -69994,7 +181148,31 @@ "desc" : "Insert node(s) as the last child node of this node.", "sig" : "(node)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "Node/Array", + "desc" : "The node or Array of nodes to append", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The appended node if single append, or null if an array was passed" + } + ] }, { "name" : "bubble", @@ -70002,7 +181180,37 @@ "desc" : "Bubbles up the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped.", "sig" : "(fn, scope, args)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to current node)", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Array", + "desc" : "(optional) The args to call the function with (default to passing the current node)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "capture", @@ -70010,7 +181218,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "cascade", @@ -70018,7 +181256,37 @@ "desc" : "Cascades down the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch.", "sig" : "(fn, scope, args)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to current node)", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Array", + "desc" : "(optional) The args to call the function with (default to passing the current node)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "contains", @@ -70026,7 +181294,31 @@ "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.", "sig" : "(node)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "eachChild", @@ -70034,7 +181326,37 @@ "desc" : "Interates the child nodes of this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops.", "sig" : "(fn, scope, args)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to current node)", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Array", + "desc" : "(optional) The args to call the function with (default to passing the current node)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "findChild", @@ -70042,7 +181364,37 @@ "desc" : "Finds the first child that has the attribute with the specified value.", "sig" : "(attribute, value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "attribute", + "type" : "String", + "desc" : "The attribute name", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to search for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The found child or null if none was found" + } + ] }, { "name" : "findChildBy", @@ -70050,7 +181402,37 @@ "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.", "sig" : "(fn, scope)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The found child or null if none was found" + } + ] }, { "name" : "fireEvent", @@ -70058,7 +181440,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getDepth", @@ -70066,7 +181478,24 @@ "desc" : "Returns depth of this node (the root node has a depth of 0)", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] }, { "name" : "getOwnerTree", @@ -70074,7 +181503,24 @@ "desc" : "Returns the tree this node is in.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Tree", + "desc" : "" + } + ] }, { "name" : "getPath", @@ -70082,7 +181528,31 @@ "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.", "sig" : "(attr)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "attr", + "type" : "String", + "desc" : "(optional) The attr to use for the path (defaults to the node's id)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The path" + } + ] }, { "name" : "hasListener", @@ -70090,7 +181560,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "indexOf", @@ -70098,7 +181592,31 @@ "desc" : "Returns the index of a child node", "sig" : "(node)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The index of the node or -1 if it was not found" + } + ] }, { "name" : "insertBefore", @@ -70106,7 +181624,37 @@ "desc" : "Inserts the first node before the second node in this nodes childNodes collection.", "sig" : "(node, refNode)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node to insert", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The node to insert before (if null the node is appended)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The inserted node" + } + ] }, { "name" : "isAncestor", @@ -70114,7 +181662,31 @@ "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.", "sig" : "(node)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isFirst", @@ -70122,7 +181694,24 @@ "desc" : "Returns true if this node is the first child of its parent", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isLast", @@ -70130,7 +181719,24 @@ "desc" : "Returns true if this node is the last child of its parent", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isLeaf", @@ -70138,7 +181744,24 @@ "desc" : "Returns true if this node is a leaf", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "item", @@ -70146,7 +181769,31 @@ "desc" : "Returns the child node at the specified index.", "sig" : "(index)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "" + } + ] }, { "name" : "on", @@ -70154,7 +181801,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -70162,7 +181845,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -70170,7 +181864,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "removeChild", @@ -70178,7 +181890,31 @@ "desc" : "Removes a child node from this node.", "sig" : "(node)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node to remove", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The removed node" + } + ] }, { "name" : "removeListener", @@ -70186,7 +181922,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "replaceChild", @@ -70194,7 +181960,37 @@ "desc" : "Replaces one child node in this node with another.", "sig" : "(newChild, oldChild)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "newChild", + "type" : "Node", + "desc" : "The replacement node", + "isOptional" : false + }, + { + "name" : "oldChild", + "type" : "Node", + "desc" : "The node to replace", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The replaced node" + } + ] }, { "name" : "sort", @@ -70202,7 +181998,31 @@ "desc" : "Sorts this nodes children using the supplied sort function", "sig" : "(fn, scope)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "un", @@ -70210,7 +182030,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -70224,7 +182074,18 @@ "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nCommits all changes made to the Record since either creation, or the last commit operation.\n

\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof commit operations.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "copy", @@ -70232,7 +182093,31 @@ "desc" : "Creates a copy of this record.", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "(optional) A new record id if you don't want to use this record's id", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Record", + "desc" : "" + } + ] }, { "name" : "create", @@ -70240,7 +182125,25 @@ "desc" : "Generate a constructor for a specific record layout.", "sig" : "(o)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "o", + "type" : "Array", + "desc" : "An Array of field definition objects which specify field names, and optionally,\ndata types, and a mapping for an {@link Roo.data.Reader} to extract the field's value from a data object.\nEach field definition object may contain the following properties:

\n
usage:
\nvar TopicRecord = Roo.data.Record.create(\n    {name: 'title', mapping: 'topic_title'},\n    {name: 'author', mapping: 'username'},\n    {name: 'totalPosts', mapping: 'topic_replies', type: 'int'},\n    {name: 'lastPost', mapping: 'post_time', type: 'date'},\n    {name: 'lastPoster', mapping: 'user2'},\n    {name: 'excerpt', mapping: 'post_text'}\n);\n\nvar myNewRecord = new TopicRecord({\n    title: 'Do my job please',\n    author: 'noobie',\n    totalPosts: 1,\n    lastPost: new Date(),\n    lastPoster: 'Animal',\n    excerpt: 'No way dude!'\n});\nmyStore.add(myNewRecord);\n
", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "get", @@ -70248,7 +182151,31 @@ "desc" : "Get the value of the named field.", "sig" : "(name)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "name", + "type" : "String", + "desc" : "The name of the field to get the value of.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The value of the field." + } + ] }, { "name" : "reject", @@ -70256,7 +182183,18 @@ "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nRejects all changes made to the Record since either creation, or the last commit operation.\nModified fields are reverted to their original values.\n

\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof reject operations.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "set", @@ -70264,7 +182202,31 @@ "desc" : "Set the named field to the specified value.", "sig" : "(name, value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "name", + "type" : "String", + "desc" : "The name of the field to set.", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Object", + "desc" : "The value to set the field to.", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -70303,7 +182265,18 @@ "desc" : "Abort the current server request.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "load", @@ -70311,7 +182284,49 @@ "desc" : "Load data from the configured URL, read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.", "sig" : "(params, reader, callback, scope, arg)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "params", + "type" : "Object", + "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.", + "isOptional" : false + }, + { + "name" : "reader", + "type" : "Roo.data.DataReader", + "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "The function into which to pass the block of Roo.data.Records.\nThe function must be passed

", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "The scope in which to call the callback", + "isOptional" : false + }, + { + "name" : "arg", + "type" : "Object", + "desc" : "An optional argument which is passed to the callback as its second parameter.", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -70368,8 +182383,8 @@ { "name" : "proxy", "type" : "Roo.data.DataProxy", - "desc" : "The Proxy object which provides access to a data object.", - "memberOf" : "Roo.data.Store" + "desc" : "[not-required]", + "memberOf" : "" }, { "name" : "pruneModifiedRecords", @@ -70380,8 +182395,8 @@ { "name" : "reader", "type" : "Roo.data.Reader", - "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their id property.", - "memberOf" : "Roo.data.Store" + "desc" : "[not-required]", + "memberOf" : "" }, { "name" : "remoteSort", @@ -70402,70 +182417,290 @@ "type" : "function", "desc" : "Fires when Records have been added to the Store", "sig" : "function (_self, records, index)\n{\n\n}", - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "The array of Records added", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index at which the record(s) were added", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeload", "type" : "function", "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.", "sig" : "function (_self, options)\n{\n\n}", - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The loading options that were specified (see {@link #load} for details)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeloadadd", "type" : "function", "desc" : "Fires after a new set of Records has been loaded.", "sig" : "function (_self, records, options)\n{\n\n}", - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "The Records that were loaded", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The loading options that were specified (see {@link #load} for details)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "clear", "type" : "function", "desc" : "Fires when the data cache has been cleared.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "datachanged", "type" : "function", "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "load", "type" : "function", "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.", "sig" : "function (_self, records, options)\n{\n\n}", - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "The Records that were loaded", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The loading options that were specified (see {@link #load} for details)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "loadexception", "type" : "function", "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args", "sig" : "function (, return, load, jsonData)\n{\n\n}", - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "", + "type" : "Proxy", + "desc" : "", + "isOptional" : false + }, + { + "name" : "return", + "type" : "Object", + "desc" : "from JsonData.reader() - success, totalRecords, records", + "isOptional" : false + }, + { + "name" : "load", + "type" : "Object", + "desc" : "options", + "isOptional" : false + }, + { + "name" : "jsonData", + "type" : "Object", + "desc" : "from your request (normally this contains the Exception)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "metachange", "type" : "function", "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.", "sig" : "function (_self, meta)\n{\n\n}", - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "meta", + "type" : "Object", + "desc" : "The JSON metadata", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "remove", "type" : "function", "desc" : "Fires when a Record has been removed from the Store", "sig" : "function (_self, record, index)\n{\n\n}", - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The Record that was removed", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index at which the record was removed", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "update", "type" : "function", "desc" : "Fires when a Record has been updated", "sig" : "function (_self, record, operation)\n{\n\n}", - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The Record that was updated", + "isOptional" : false + }, + { + "name" : "operation", + "type" : "String", + "desc" : "The update operation being performed. Value may be one of:\n
\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n
", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -70475,7 +182710,25 @@ "desc" : "Add Records to the Store and fires the add event.", "sig" : "(records)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "An Array of Roo.data.Record objects to add to the cache.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addEvents", @@ -70483,7 +182736,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -70491,7 +182762,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -70499,7 +182806,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearFilter", @@ -70507,7 +182844,25 @@ "desc" : "Revert to a view of the Record cache with no filtering applied.", "sig" : "(suppressEvent)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "suppressEvent", + "type" : "Boolean", + "desc" : "If true the filter is cleared silently without notifying listeners", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "collect", @@ -70515,7 +182870,43 @@ "desc" : "Collects unique values for a particular dataIndex from this store.", "sig" : "(dataIndex, allowNull, bypassFilter)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "dataIndex", + "type" : "String", + "desc" : "The property to collect", + "isOptional" : false + }, + { + "name" : "allowNull", + "type" : "Boolean", + "desc" : "(optional) Pass true to allow null, undefined or empty string values", + "isOptional" : false + }, + { + "name" : "bypassFilter", + "type" : "Boolean", + "desc" : "(optional) Pass true to collect from all records, even ones which are filtered", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "An array of the unique values" + } + ] }, { "name" : "commitChanges", @@ -70523,7 +182914,18 @@ "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "each", @@ -70531,7 +182933,31 @@ "desc" : "Calls the specified function for each of the Records in the cache.", "sig" : "(fn, scope)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call. The Record is passed as the first parameter.\nReturning false aborts and exits the iteration.", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to call the function (defaults to the Record).", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "filter", @@ -70539,7 +182965,37 @@ "desc" : "Filter the records by a specified property.", "sig" : "(field, value, anyMatch)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "field", + "type" : "String", + "desc" : "A field on your records", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String/RegExp", + "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field", + "isOptional" : false + }, + { + "name" : "anyMatch", + "type" : "Boolean", + "desc" : "True to match any part not just the beginning", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "filterBy", @@ -70547,7 +183003,31 @@ "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.", "sig" : "(fn, scope)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to be called, it will receive 2 args (record, id)", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to this)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -70555,7 +183035,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getAt", @@ -70563,7 +183073,31 @@ "desc" : "Get the Record at the specified index.", "sig" : "(index)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the Record to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record", + "desc" : "The Record at the passed index. Returns undefined if not found." + } + ] }, { "name" : "getById", @@ -70571,7 +183105,31 @@ "desc" : "Get the Record with the specified id.", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id of the Record to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record", + "desc" : "The Record with the passed id. Returns undefined if not found." + } + ] }, { "name" : "getCount", @@ -70579,7 +183137,18 @@ "desc" : "Gets the number of cached records.\n

\nIf using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "getModifiedRecords", @@ -70587,7 +183156,24 @@ "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record[]", + "desc" : "An array of Records containing outstanding modifications." + } + ] }, { "name" : "getRange", @@ -70595,7 +183181,37 @@ "desc" : "Returns a range of Records between specified indices.", "sig" : "(startIndex, endIndex)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "startIndex", + "type" : "Number", + "desc" : "(optional) The starting index (defaults to 0)", + "isOptional" : false + }, + { + "name" : "endIndex", + "type" : "Number", + "desc" : "(optional) The ending index (defaults to the last Record in the Store)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record[]", + "desc" : "An array of Records" + } + ] }, { "name" : "getSortState", @@ -70603,7 +183219,18 @@ "desc" : "Returns the sort state of the Store as an object with two properties:\n

\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n
", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "getTotalCount", @@ -70611,7 +183238,18 @@ "desc" : "Gets the total number of records in the dataset as returned by the server.\n

\nIf using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -70619,7 +183257,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "indexOf", @@ -70627,7 +183289,31 @@ "desc" : "Get the index within the cache of the passed Record.", "sig" : "(record)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The Roo.data.Record object to to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The index of the passed Record. Returns -1 if not found." + } + ] }, { "name" : "indexOfId", @@ -70635,7 +183321,31 @@ "desc" : "Get the index within the cache of the Record with the passed id.", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id of the Record to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The index of the Record. Returns -1 if not found." + } + ] }, { "name" : "insert", @@ -70643,7 +183353,31 @@ "desc" : "Inserts Records to the Store at the given index and fires the add event.", "sig" : "(index, records)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The start index at which to insert the passed Records.", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "An Array of Roo.data.Record objects to add to the cache.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "load", @@ -70651,7 +183385,25 @@ "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n

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

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

", "sig" : "(options)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "An object containing properties which control loading options:

", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "loadData", @@ -70659,7 +183411,31 @@ "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.", "sig" : "(data, append)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "data", + "type" : "Object", + "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.", + "isOptional" : false + }, + { + "name" : "append", + "type" : "Boolean", + "desc" : "(Optional) True to append the new Records rather than replace the existing cache.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "loadDataFromChildren", @@ -70667,7 +183443,25 @@ "desc" : "using 'cn' the nested child reader read the child array into it's child stores.", "sig" : "(rec)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "rec", + "type" : "Object", + "desc" : "The record with a 'children array", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -70675,7 +183469,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -70683,7 +183513,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "query", @@ -70691,7 +183532,43 @@ "desc" : "Query the records by a specified property.", "sig" : "(field, value, anyMatch)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "field", + "type" : "String", + "desc" : "A field on your records", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String/RegExp", + "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field", + "isOptional" : false + }, + { + "name" : "anyMatch", + "type" : "Boolean", + "desc" : "True to match any part not just the beginning", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "MixedCollection", + "desc" : "Returns an Roo.util.MixedCollection of the matched records" + } + ] }, { "name" : "queryBy", @@ -70699,7 +183576,37 @@ "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.", "sig" : "(fn, scope)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to be called, it will receive 2 args (record, id)", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to this)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "MixedCollection", + "desc" : "Returns an Roo.util.MixedCollection of the matched records" + } + ] }, { "name" : "rejectChanges", @@ -70707,7 +183614,18 @@ "desc" : "Cancel outstanding changes on all changed records.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -70715,7 +183633,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "reload", @@ -70723,7 +183659,25 @@ "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.", "sig" : "(options)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "remove", @@ -70731,7 +183685,25 @@ "desc" : "Remove a Record from the Store and fires the remove event.", "sig" : "(record)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "record", + "type" : "Ext.data.Record", + "desc" : "The Roo.data.Record object to remove from the cache.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeAll", @@ -70739,7 +183711,18 @@ "desc" : "Remove all Records from the Store and fires the clear event.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "removeListener", @@ -70747,7 +183730,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "setDefaultSort", @@ -70755,7 +183768,31 @@ "desc" : "Sets the default sort column and order to be used by the next load operation.", "sig" : "(fieldName, dir)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fieldName", + "type" : "String", + "desc" : "The name of the field to sort by.", + "isOptional" : false + }, + { + "name" : "dir", + "type" : "String", + "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "sort", @@ -70763,7 +183800,31 @@ "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.", "sig" : "(fieldName, dir)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fieldName", + "type" : "String", + "desc" : "The name of the field to sort by.", + "isOptional" : false + }, + { + "name" : "dir", + "type" : "String", + "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "sum", @@ -70771,7 +183832,43 @@ "desc" : "Sums the value of property for each record between start and end and returns the result.", "sig" : "(property, start, end)", "static" : false, - "memberOf" : "Roo.data.Store" + "memberOf" : "Roo.data.Store", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "property", + "type" : "String", + "desc" : "A field on your records", + "isOptional" : false + }, + { + "name" : "start", + "type" : "Number", + "desc" : "The record index to start at (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "The last record index to include (defaults to length - 1)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The sum" + } + ] }, { "name" : "un", @@ -70779,7 +183876,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -70793,7 +183920,31 @@ "desc" : "Date sorting", "sig" : "(s)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "s", + "type" : "Mixed", + "desc" : "The value being converted", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The comparison value" + } + ] }, { "name" : "asFloat", @@ -70801,7 +183952,31 @@ "desc" : "Float sorting", "sig" : "(s)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "s", + "type" : "Mixed", + "desc" : "The value being converted", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Float", + "desc" : "The comparison value" + } + ] }, { "name" : "asInt", @@ -70809,7 +183984,31 @@ "desc" : "Integer sorting", "sig" : "(s)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "s", + "type" : "Mixed", + "desc" : "The value being converted", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The comparison value" + } + ] }, { "name" : "asText", @@ -70817,7 +184016,31 @@ "desc" : "Strips all HTML tags to sort on text only", "sig" : "(s)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "s", + "type" : "Mixed", + "desc" : "The value being converted", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The comparison value" + } + ] }, { "name" : "asUCString", @@ -70825,7 +184048,31 @@ "desc" : "Case insensitive string", "sig" : "(s)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "s", + "type" : "Mixed", + "desc" : "The value being converted", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The comparison value" + } + ] }, { "name" : "asUCText", @@ -70833,7 +184080,31 @@ "desc" : "Strips all HTML tags to sort on text only - Case insensitive", "sig" : "(s)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "s", + "type" : "Mixed", + "desc" : "The value being converted", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The comparison value" + } + ] }, { "name" : "none", @@ -70841,7 +184112,31 @@ "desc" : "Default sort that does nothing", "sig" : "(s)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "s", + "type" : "Mixed", + "desc" : "The value being converted", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "The comparison value" + } + ] } ] }, @@ -70880,7 +184175,7 @@ { "name" : "proxy", "type" : "Roo.data.DataProxy", - "desc" : "The Proxy object which provides access to a data object.", + "desc" : "[required] The Proxy object which provides access to a data object.", "memberOf" : "" }, { @@ -70891,8 +184186,8 @@ }, { "name" : "reader", - "type" : "Roo.data.Reader", - "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their id property.", + "type" : "Roo.data.DataReader", + "desc" : "[required] The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their id property.", "memberOf" : "" }, { @@ -70914,70 +184209,290 @@ "type" : "function", "desc" : "Fires when Records have been added to the Store", "sig" : "function (_self, records, index)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "The array of Records added", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index at which the record(s) were added", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeload", "type" : "function", "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.", "sig" : "function (_self, options)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The loading options that were specified (see {@link #load} for details)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeloadadd", "type" : "function", "desc" : "Fires after a new set of Records has been loaded.", "sig" : "function (_self, records, options)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "The Records that were loaded", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The loading options that were specified (see {@link #load} for details)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "clear", "type" : "function", "desc" : "Fires when the data cache has been cleared.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "datachanged", "type" : "function", "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "load", "type" : "function", "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.", "sig" : "function (_self, records, options)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "The Records that were loaded", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "The loading options that were specified (see {@link #load} for details)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "loadexception", "type" : "function", "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args", "sig" : "function (, return, load, jsonData)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "", + "type" : "Proxy", + "desc" : "", + "isOptional" : false + }, + { + "name" : "return", + "type" : "Object", + "desc" : "from JsonData.reader() - success, totalRecords, records", + "isOptional" : false + }, + { + "name" : "load", + "type" : "Object", + "desc" : "options", + "isOptional" : false + }, + { + "name" : "jsonData", + "type" : "Object", + "desc" : "from your request (normally this contains the Exception)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "metachange", "type" : "function", "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.", "sig" : "function (_self, meta)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "meta", + "type" : "Object", + "desc" : "The JSON metadata", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "remove", "type" : "function", "desc" : "Fires when a Record has been removed from the Store", "sig" : "function (_self, record, index)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The Record that was removed", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index at which the record was removed", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "update", "type" : "function", "desc" : "Fires when a Record has been updated", "sig" : "function (_self, record, operation)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Store", + "desc" : "", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The Record that was updated", + "isOptional" : false + }, + { + "name" : "operation", + "type" : "String", + "desc" : "The update operation being performed. Value may be one of:\n
\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n
", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -70987,7 +184502,25 @@ "desc" : "Add Records to the Store and fires the add event.", "sig" : "(records)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "An Array of Roo.data.Record objects to add to the cache.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addEvents", @@ -70995,7 +184528,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -71003,7 +184554,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -71011,7 +184598,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearFilter", @@ -71019,7 +184636,25 @@ "desc" : "Revert to a view of the Record cache with no filtering applied.", "sig" : "(suppressEvent)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "suppressEvent", + "type" : "Boolean", + "desc" : "If true the filter is cleared silently without notifying listeners", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "collect", @@ -71027,7 +184662,43 @@ "desc" : "Collects unique values for a particular dataIndex from this store.", "sig" : "(dataIndex, allowNull, bypassFilter)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "dataIndex", + "type" : "String", + "desc" : "The property to collect", + "isOptional" : false + }, + { + "name" : "allowNull", + "type" : "Boolean", + "desc" : "(optional) Pass true to allow null, undefined or empty string values", + "isOptional" : false + }, + { + "name" : "bypassFilter", + "type" : "Boolean", + "desc" : "(optional) Pass true to collect from all records, even ones which are filtered", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "An array of the unique values" + } + ] }, { "name" : "commitChanges", @@ -71035,7 +184706,18 @@ "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "each", @@ -71043,7 +184725,31 @@ "desc" : "Calls the specified function for each of the Records in the cache.", "sig" : "(fn, scope)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call. The Record is passed as the first parameter.\nReturning false aborts and exits the iteration.", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to call the function (defaults to the Record).", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "filter", @@ -71051,7 +184757,37 @@ "desc" : "Filter the records by a specified property.", "sig" : "(field, value, anyMatch)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "field", + "type" : "String", + "desc" : "A field on your records", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String/RegExp", + "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field", + "isOptional" : false + }, + { + "name" : "anyMatch", + "type" : "Boolean", + "desc" : "True to match any part not just the beginning", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "filterBy", @@ -71059,7 +184795,31 @@ "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.", "sig" : "(fn, scope)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to be called, it will receive 2 args (record, id)", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to this)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -71067,7 +184827,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getAt", @@ -71075,7 +184865,31 @@ "desc" : "Get the Record at the specified index.", "sig" : "(index)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the Record to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record", + "desc" : "The Record at the passed index. Returns undefined if not found." + } + ] }, { "name" : "getById", @@ -71083,7 +184897,31 @@ "desc" : "Get the Record with the specified id.", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id of the Record to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record", + "desc" : "The Record with the passed id. Returns undefined if not found." + } + ] }, { "name" : "getCount", @@ -71091,7 +184929,18 @@ "desc" : "Gets the number of cached records.\n

\nIf using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "getModifiedRecords", @@ -71099,7 +184948,24 @@ "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record[]", + "desc" : "An array of Records containing outstanding modifications." + } + ] }, { "name" : "getRange", @@ -71107,7 +184973,37 @@ "desc" : "Returns a range of Records between specified indices.", "sig" : "(startIndex, endIndex)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "startIndex", + "type" : "Number", + "desc" : "(optional) The starting index (defaults to 0)", + "isOptional" : false + }, + { + "name" : "endIndex", + "type" : "Number", + "desc" : "(optional) The ending index (defaults to the last Record in the Store)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record[]", + "desc" : "An array of Records" + } + ] }, { "name" : "getSortState", @@ -71115,7 +185011,18 @@ "desc" : "Returns the sort state of the Store as an object with two properties:\n

\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n
", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "getTotalCount", @@ -71123,7 +185030,18 @@ "desc" : "Gets the total number of records in the dataset as returned by the server.\n

\nIf using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -71131,7 +185049,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "indexOf", @@ -71139,7 +185081,31 @@ "desc" : "Get the index within the cache of the passed Record.", "sig" : "(record)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The Roo.data.Record object to to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The index of the passed Record. Returns -1 if not found." + } + ] }, { "name" : "indexOfId", @@ -71147,7 +185113,31 @@ "desc" : "Get the index within the cache of the Record with the passed id.", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id of the Record to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The index of the Record. Returns -1 if not found." + } + ] }, { "name" : "insert", @@ -71155,7 +185145,31 @@ "desc" : "Inserts Records to the Store at the given index and fires the add event.", "sig" : "(index, records)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The start index at which to insert the passed Records.", + "isOptional" : false + }, + { + "name" : "records", + "type" : "Roo.data.Record[]", + "desc" : "An Array of Roo.data.Record objects to add to the cache.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "load", @@ -71163,7 +185177,25 @@ "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n

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

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

", "sig" : "(options)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "An object containing properties which control loading options:

", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "loadData", @@ -71171,7 +185203,31 @@ "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.", "sig" : "(data, append)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "data", + "type" : "Object", + "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.", + "isOptional" : false + }, + { + "name" : "append", + "type" : "Boolean", + "desc" : "(Optional) True to append the new Records rather than replace the existing cache.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "loadDataFromChildren", @@ -71179,7 +185235,25 @@ "desc" : "using 'cn' the nested child reader read the child array into it's child stores.", "sig" : "(rec)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "rec", + "type" : "Object", + "desc" : "The record with a 'children array", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -71187,7 +185261,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -71195,7 +185305,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "query", @@ -71203,7 +185324,43 @@ "desc" : "Query the records by a specified property.", "sig" : "(field, value, anyMatch)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "field", + "type" : "String", + "desc" : "A field on your records", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String/RegExp", + "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field", + "isOptional" : false + }, + { + "name" : "anyMatch", + "type" : "Boolean", + "desc" : "True to match any part not just the beginning", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "MixedCollection", + "desc" : "Returns an Roo.util.MixedCollection of the matched records" + } + ] }, { "name" : "queryBy", @@ -71211,7 +185368,37 @@ "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.", "sig" : "(fn, scope)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to be called, it will receive 2 args (record, id)", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to this)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "MixedCollection", + "desc" : "Returns an Roo.util.MixedCollection of the matched records" + } + ] }, { "name" : "rejectChanges", @@ -71219,7 +185406,18 @@ "desc" : "Cancel outstanding changes on all changed records.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -71227,7 +185425,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "reload", @@ -71235,7 +185451,25 @@ "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.", "sig" : "(options)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "remove", @@ -71243,7 +185477,25 @@ "desc" : "Remove a Record from the Store and fires the remove event.", "sig" : "(record)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "record", + "type" : "Ext.data.Record", + "desc" : "The Roo.data.Record object to remove from the cache.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeAll", @@ -71251,7 +185503,18 @@ "desc" : "Remove all Records from the Store and fires the clear event.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "removeListener", @@ -71259,7 +185522,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "setDefaultSort", @@ -71267,7 +185560,31 @@ "desc" : "Sets the default sort column and order to be used by the next load operation.", "sig" : "(fieldName, dir)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fieldName", + "type" : "String", + "desc" : "The name of the field to sort by.", + "isOptional" : false + }, + { + "name" : "dir", + "type" : "String", + "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "sort", @@ -71275,7 +185592,31 @@ "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.", "sig" : "(fieldName, dir)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fieldName", + "type" : "String", + "desc" : "The name of the field to sort by.", + "isOptional" : false + }, + { + "name" : "dir", + "type" : "String", + "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "sum", @@ -71283,7 +185624,43 @@ "desc" : "Sums the value of property for each record between start and end and returns the result.", "sig" : "(property, start, end)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "property", + "type" : "String", + "desc" : "A field on your records", + "isOptional" : false + }, + { + "name" : "start", + "type" : "Number", + "desc" : "The record index to start at (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "The last record index to include (defaults to length - 1)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The sum" + } + ] }, { "name" : "un", @@ -71291,7 +185668,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -71310,56 +185717,298 @@ "type" : "function", "desc" : "Fires when a new child node is appended to a node in this tree.", "sig" : "function (tree, parent, node, index)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The newly appended node", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the newly appended node", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeappend", "type" : "function", "desc" : "Fires before a new child is appended to a node in this tree, return false to cancel the append.", "sig" : "function (tree, parent, node)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be appended", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeinsert", "type" : "function", "desc" : "Fires before a new child is inserted in a node in this tree, return false to cancel the insert.", "sig" : "function (tree, parent, node, refNode)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be inserted", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The child node the node is being inserted before", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforemove", "type" : "function", "desc" : "Fires before a node is moved to a new location in the tree. Return false to cancel the move.", "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The node being moved", + "isOptional" : false + }, + { + "name" : "oldParent", + "type" : "Node", + "desc" : "The parent of the node", + "isOptional" : false + }, + { + "name" : "newParent", + "type" : "Node", + "desc" : "The new parent the node is moving to", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index it is being moved to", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeremove", "type" : "function", "desc" : "Fires before a child is removed from a node in this tree, return false to cancel the remove.", "sig" : "function (tree, parent, node)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be removed", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "insert", "type" : "function", "desc" : "Fires when a new child node is inserted in a node in this tree.", "sig" : "function (tree, parent, node, refNode)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node inserted", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The child node the node was inserted before", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires when a node is moved to a new location in the tree", "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The node moved", + "isOptional" : false + }, + { + "name" : "oldParent", + "type" : "Node", + "desc" : "The old parent of this node", + "isOptional" : false + }, + { + "name" : "newParent", + "type" : "Node", + "desc" : "The new parent of this node", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index it was moved to", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "remove", "type" : "function", "desc" : "Fires when a child node is removed from a node in this tree.", "sig" : "function (tree, parent, node)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node removed", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -71369,7 +186018,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -71377,7 +186044,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -71385,7 +186088,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "fireEvent", @@ -71393,7 +186126,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getNodeById", @@ -71401,7 +186164,31 @@ "desc" : "Gets a node in this tree by its id.", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "" + } + ] }, { "name" : "getRootNode", @@ -71409,7 +186196,24 @@ "desc" : "Returns the root node for this tree.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -71417,7 +186221,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "on", @@ -71425,7 +186253,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -71433,7 +186297,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -71441,7 +186316,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -71449,7 +186342,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "setRootNode", @@ -71457,7 +186380,31 @@ "desc" : "Sets the root node for this tree.", "sig" : "(node)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "" + } + ] }, { "name" : "un", @@ -71465,7 +186412,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -71504,7 +186481,31 @@ "desc" : "Create an empty record", "sig" : "(data)", "static" : false, - "memberOf" : "Roo.data.DataReader" + "memberOf" : "Roo.data.DataReader", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "data", + "type" : "Object", + "desc" : "(optional) - overlay some values", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.data.Record", + "desc" : "record created." + } + ] }, { "name" : "read", @@ -71512,7 +186513,31 @@ "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.", "sig" : "(response)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "response", + "type" : "Object", + "desc" : "The XHR object which contains the parsed XML document. The response is expected\nto contain a method called 'responseXML' that returns an XML document object.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "records A data block which is used by an {@link Roo.data.Store} as\na cache of Roo.data.Records." + } + ] }, { "name" : "readRecords", @@ -71520,7 +186545,31 @@ "desc" : "Create a data block containing Roo.data.Records from an XML document.", "sig" : "(doc)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "doc", + "type" : "Object", + "desc" : "A parsed XML document.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "records A data block which is used by an {@link Roo.data.Store} as\na cache of Roo.data.Records." + } + ] } ] }, @@ -71546,7 +186595,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addInvalidHandleClass", @@ -71554,7 +186621,25 @@ "desc" : "Lets you specify a css class of elements that will not initiate a drag", "sig" : "(cssClass)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the elements you wish to ignore", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addInvalidHandleId", @@ -71562,7 +186647,25 @@ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the element id of the element you wish to ignore", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addInvalidHandleType", @@ -71570,7 +186673,25 @@ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", "sig" : "(tagName)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to exclude", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addListener", @@ -71578,7 +186699,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "addToGroup", @@ -71586,7 +186743,25 @@ "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", "sig" : "(sGroup)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "", + "desc" : "{string} the name of the group", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "alignElWithMouse", @@ -71594,7 +186769,37 @@ "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", "sig" : "(el, iPageX, iPageY)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "HTMLElement", + "desc" : "the element to move", + "isOptional" : false + }, + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the mousedown or drag event", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the mousedown or drag event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "applyConfig", @@ -71602,7 +186807,18 @@ "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "autoOffset", @@ -71610,7 +186826,31 @@ "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked", "sig" : "(iPageX, iPageY)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the click", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the click", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "cachePosition", @@ -71618,7 +186858,31 @@ "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.", "sig" : "(iPageX, iPageY)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "", + "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "", + "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "capture", @@ -71626,7 +186890,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearConstraints", @@ -71634,7 +186928,18 @@ "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "clearTicks", @@ -71642,7 +186947,18 @@ "desc" : "Clears any tick interval defined for this instance", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "endDrag", @@ -71650,7 +186966,25 @@ "desc" : "Fired when we are done dragging the object", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -71658,7 +186992,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getDragEl", @@ -71666,7 +187030,24 @@ "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] }, { "name" : "getEl", @@ -71674,7 +187055,24 @@ "desc" : "Returns a reference to the linked element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] }, { "name" : "hasListener", @@ -71682,7 +187080,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "init", @@ -71690,7 +187112,37 @@ "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", "sig" : "(id, sGroup, config)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "initTarget", @@ -71698,7 +187150,37 @@ "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", "sig" : "(id, sGroup, config)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "isLocked", @@ -71706,7 +187188,24 @@ "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this obj or all drag/drop is locked, else\nfalse" + } + ] }, { "name" : "isTarget", @@ -71714,7 +187213,18 @@ "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValidHandleChild", @@ -71722,7 +187232,31 @@ "desc" : "Checks the tag exclusion list to see if this click should be ignored", "sig" : "(node)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "the HTMLElement to evaluate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this is a valid tag type, false if not" + } + ] }, { "name" : "lock", @@ -71730,7 +187264,18 @@ "desc" : "Lock this instance", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -71738,7 +187283,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onAvailable", @@ -71746,7 +187327,18 @@ "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "onDrag", @@ -71754,7 +187346,25 @@ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragDrop", @@ -71762,7 +187372,31 @@ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragEnter", @@ -71770,7 +187404,31 @@ "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragOut", @@ -71778,7 +187436,31 @@ "desc" : "Abstract method called when we are no longer hovering over an element", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragOver", @@ -71786,7 +187468,31 @@ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onInvalidDrop", @@ -71794,7 +187500,25 @@ "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onMouseDown", @@ -71802,7 +187526,25 @@ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousedown event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onMouseUp", @@ -71810,7 +187552,25 @@ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "padding", @@ -71818,7 +187578,18 @@ "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "purgeListeners", @@ -71826,7 +187597,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -71834,7 +187616,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "removeFromGroup", @@ -71842,7 +187642,25 @@ "desc" : "Remove's this instance from the supplied interaction group", "sig" : "(sGroup)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "string", + "desc" : "The group to drop", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleClass", @@ -71850,7 +187668,25 @@ "desc" : "Unsets an invalid css class", "sig" : "(cssClass)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the element(s) you wish to\nre-enable", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleId", @@ -71858,7 +187694,25 @@ "desc" : "Unsets an invalid handle id", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the id of the element to re-enable", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleType", @@ -71866,7 +187720,25 @@ "desc" : "Unsets an excluded tag name set by addInvalidHandleType", "sig" : "(tagName)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to unexclude", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeListener", @@ -71874,7 +187746,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "resetConstraints", @@ -71882,7 +187784,25 @@ "desc" : "resetConstraints must be called if you manually reposition a dd element.", "sig" : "(maintainOffset)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "maintainOffset", + "type" : "boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDelta", @@ -71890,7 +187810,31 @@ "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)", "sig" : "(iDeltaX, iDeltaY)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iDeltaX", + "type" : "int", + "desc" : "the distance from the left", + "isOptional" : false + }, + { + "name" : "iDeltaY", + "type" : "int", + "desc" : "the distance from the top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDragElId", @@ -71898,7 +187842,25 @@ "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDragElPos", @@ -71906,7 +187868,31 @@ "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", "sig" : "(iPageX, iPageY)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the mousedown or drag event", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the mousedown or drag event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setHandleElId", @@ -71914,7 +187900,25 @@ "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to\ninitiate the drag.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setInitPosition", @@ -71922,7 +187926,31 @@ "desc" : "Stores the initial placement of the linked element.", "sig" : "(diffX, diffY)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "diffX", + "type" : "int", + "desc" : "the X offset, default 0", + "isOptional" : false + }, + { + "name" : "diffY", + "type" : "int", + "desc" : "the Y offset, default 0", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setOuterHandleElId", @@ -71930,7 +187958,25 @@ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPadding", @@ -71938,7 +187984,43 @@ "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", "sig" : "(iTop, iRight, iBot, iLeft)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iTop", + "type" : "int", + "desc" : "Top pad", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "Right pad", + "isOptional" : false + }, + { + "name" : "iBot", + "type" : "int", + "desc" : "Bot pad", + "isOptional" : false + }, + { + "name" : "iLeft", + "type" : "int", + "desc" : "Left pad", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setXConstraint", @@ -71946,7 +188028,37 @@ "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", "sig" : "(iLeft, iRight, iTickSize)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iLeft", + "type" : "int", + "desc" : "the number of pixels the element can move to the left", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "the number of pixels the element can move to the\nright", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setYConstraint", @@ -71954,7 +188066,37 @@ "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", "sig" : "(iUp, iDown, iTickSize)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iUp", + "type" : "int", + "desc" : "the number of pixels the element can move up", + "isOptional" : false + }, + { + "name" : "iDown", + "type" : "int", + "desc" : "the number of pixels the element can move down", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "startDrag", @@ -71962,7 +188104,31 @@ "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", "sig" : "(X, Y)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "X", + "type" : "int", + "desc" : "click location", + "isOptional" : false + }, + { + "name" : "Y", + "type" : "int", + "desc" : "click location", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "toString", @@ -71970,7 +188136,24 @@ "desc" : "toString method", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "string", + "desc" : "string representation of the dd obj" + } + ] }, { "name" : "un", @@ -71978,7 +188161,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "unlock", @@ -71986,7 +188199,18 @@ "desc" : "Unlock this instace", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "unreg", @@ -71994,7 +188218,18 @@ "desc" : "Remove all drag and drop hooks for this element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -72015,7 +188250,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addInvalidHandleClass", @@ -72023,7 +188276,25 @@ "desc" : "Lets you specify a css class of elements that will not initiate a drag", "sig" : "(cssClass)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the elements you wish to ignore", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addInvalidHandleId", @@ -72031,7 +188302,25 @@ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the element id of the element you wish to ignore", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addInvalidHandleType", @@ -72039,7 +188328,25 @@ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", "sig" : "(tagName)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to exclude", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addListener", @@ -72047,7 +188354,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "addToGroup", @@ -72055,7 +188398,25 @@ "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", "sig" : "(sGroup)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "", + "desc" : "{string} the name of the group", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "alignElWithMouse", @@ -72063,7 +188424,37 @@ "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", "sig" : "(el, iPageX, iPageY)", "static" : false, - "memberOf" : "Roo.dd.DD" + "memberOf" : "Roo.dd.DD", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "HTMLElement", + "desc" : "the element to move", + "isOptional" : false + }, + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the mousedown or drag event", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the mousedown or drag event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "applyConfig", @@ -72071,7 +188462,18 @@ "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "autoOffset", @@ -72079,7 +188481,31 @@ "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked", "sig" : "(iPageX, iPageY)", "static" : false, - "memberOf" : "Roo.dd.DD" + "memberOf" : "Roo.dd.DD", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the click", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the click", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "cachePosition", @@ -72087,7 +188513,31 @@ "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.", "sig" : "(iPageX, iPageY)", "static" : false, - "memberOf" : "Roo.dd.DD" + "memberOf" : "Roo.dd.DD", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "", + "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "", + "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "capture", @@ -72095,7 +188545,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearConstraints", @@ -72103,7 +188583,18 @@ "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "clearTicks", @@ -72111,7 +188602,18 @@ "desc" : "Clears any tick interval defined for this instance", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "createFrame", @@ -72119,7 +188621,18 @@ "desc" : "Creates the proxy element if it does not yet exist", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "endDrag", @@ -72127,7 +188640,25 @@ "desc" : "Fired when we are done dragging the object", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -72135,7 +188666,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getDragEl", @@ -72143,7 +188704,24 @@ "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] }, { "name" : "getEl", @@ -72151,7 +188729,24 @@ "desc" : "Returns a reference to the linked element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] }, { "name" : "hasListener", @@ -72159,7 +188754,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "init", @@ -72167,7 +188786,37 @@ "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", "sig" : "(id, sGroup, config)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "initFrame", @@ -72175,7 +188824,18 @@ "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initTarget", @@ -72183,7 +188843,37 @@ "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", "sig" : "(id, sGroup, config)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "isLocked", @@ -72191,7 +188881,24 @@ "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this obj or all drag/drop is locked, else\nfalse" + } + ] }, { "name" : "isTarget", @@ -72199,7 +188906,18 @@ "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValidHandleChild", @@ -72207,7 +188925,31 @@ "desc" : "Checks the tag exclusion list to see if this click should be ignored", "sig" : "(node)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "the HTMLElement to evaluate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this is a valid tag type, false if not" + } + ] }, { "name" : "lock", @@ -72215,7 +188957,18 @@ "desc" : "Lock this instance", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -72223,7 +188976,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onAvailable", @@ -72231,7 +189020,18 @@ "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "onDrag", @@ -72239,7 +189039,25 @@ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragDrop", @@ -72247,7 +189065,31 @@ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragEnter", @@ -72255,7 +189097,31 @@ "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragOut", @@ -72263,7 +189129,31 @@ "desc" : "Abstract method called when we are no longer hovering over an element", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragOver", @@ -72271,7 +189161,31 @@ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onInvalidDrop", @@ -72279,7 +189193,25 @@ "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onMouseDown", @@ -72287,7 +189219,25 @@ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousedown event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onMouseUp", @@ -72295,7 +189245,25 @@ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "padding", @@ -72303,7 +189271,18 @@ "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "purgeListeners", @@ -72311,7 +189290,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -72319,7 +189309,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "removeFromGroup", @@ -72327,7 +189335,25 @@ "desc" : "Remove's this instance from the supplied interaction group", "sig" : "(sGroup)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "string", + "desc" : "The group to drop", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleClass", @@ -72335,7 +189361,25 @@ "desc" : "Unsets an invalid css class", "sig" : "(cssClass)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the element(s) you wish to\nre-enable", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleId", @@ -72343,7 +189387,25 @@ "desc" : "Unsets an invalid handle id", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the id of the element to re-enable", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleType", @@ -72351,7 +189413,25 @@ "desc" : "Unsets an excluded tag name set by addInvalidHandleType", "sig" : "(tagName)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to unexclude", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeListener", @@ -72359,7 +189439,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "resetConstraints", @@ -72367,7 +189477,25 @@ "desc" : "resetConstraints must be called if you manually reposition a dd element.", "sig" : "(maintainOffset)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "maintainOffset", + "type" : "boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDelta", @@ -72375,7 +189503,31 @@ "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)", "sig" : "(iDeltaX, iDeltaY)", "static" : false, - "memberOf" : "Roo.dd.DD" + "memberOf" : "Roo.dd.DD", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iDeltaX", + "type" : "int", + "desc" : "the distance from the left", + "isOptional" : false + }, + { + "name" : "iDeltaY", + "type" : "int", + "desc" : "the distance from the top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDragElId", @@ -72383,7 +189535,25 @@ "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDragElPos", @@ -72391,7 +189561,31 @@ "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", "sig" : "(iPageX, iPageY)", "static" : false, - "memberOf" : "Roo.dd.DD" + "memberOf" : "Roo.dd.DD", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the mousedown or drag event", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the mousedown or drag event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setHandleElId", @@ -72399,7 +189593,25 @@ "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to\ninitiate the drag.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setInitPosition", @@ -72407,7 +189619,31 @@ "desc" : "Stores the initial placement of the linked element.", "sig" : "(diffX, diffY)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "diffX", + "type" : "int", + "desc" : "the X offset, default 0", + "isOptional" : false + }, + { + "name" : "diffY", + "type" : "int", + "desc" : "the Y offset, default 0", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setOuterHandleElId", @@ -72415,7 +189651,25 @@ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPadding", @@ -72423,7 +189677,43 @@ "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", "sig" : "(iTop, iRight, iBot, iLeft)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iTop", + "type" : "int", + "desc" : "Top pad", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "Right pad", + "isOptional" : false + }, + { + "name" : "iBot", + "type" : "int", + "desc" : "Bot pad", + "isOptional" : false + }, + { + "name" : "iLeft", + "type" : "int", + "desc" : "Left pad", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setXConstraint", @@ -72431,7 +189721,37 @@ "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", "sig" : "(iLeft, iRight, iTickSize)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iLeft", + "type" : "int", + "desc" : "the number of pixels the element can move to the left", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "the number of pixels the element can move to the\nright", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setYConstraint", @@ -72439,7 +189759,37 @@ "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", "sig" : "(iUp, iDown, iTickSize)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iUp", + "type" : "int", + "desc" : "the number of pixels the element can move up", + "isOptional" : false + }, + { + "name" : "iDown", + "type" : "int", + "desc" : "the number of pixels the element can move down", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "startDrag", @@ -72447,7 +189797,31 @@ "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", "sig" : "(X, Y)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "X", + "type" : "int", + "desc" : "click location", + "isOptional" : false + }, + { + "name" : "Y", + "type" : "int", + "desc" : "click location", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "toString", @@ -72455,7 +189829,24 @@ "desc" : "toString method", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "string", + "desc" : "string representation of the dd obj" + } + ] }, { "name" : "un", @@ -72463,7 +189854,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "unlock", @@ -72471,7 +189892,18 @@ "desc" : "Unlock this instace", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "unreg", @@ -72479,7 +189911,18 @@ "desc" : "Remove all drag and drop hooks for this element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -72500,7 +189943,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addInvalidHandleClass", @@ -72508,7 +189969,25 @@ "desc" : "Lets you specify a css class of elements that will not initiate a drag", "sig" : "(cssClass)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the elements you wish to ignore", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addInvalidHandleId", @@ -72516,7 +189995,25 @@ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the element id of the element you wish to ignore", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addInvalidHandleType", @@ -72524,7 +190021,25 @@ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", "sig" : "(tagName)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to exclude", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addListener", @@ -72532,7 +190047,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "addToGroup", @@ -72540,7 +190091,25 @@ "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", "sig" : "(sGroup)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "", + "desc" : "{string} the name of the group", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "applyConfig", @@ -72548,7 +190117,18 @@ "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -72556,7 +190136,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearConstraints", @@ -72564,7 +190174,18 @@ "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "clearTicks", @@ -72572,7 +190193,18 @@ "desc" : "Clears any tick interval defined for this instance", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "endDrag", @@ -72580,7 +190212,25 @@ "desc" : "Fired when we are done dragging the object", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -72588,7 +190238,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getDragEl", @@ -72596,7 +190276,24 @@ "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] }, { "name" : "getEl", @@ -72604,7 +190301,24 @@ "desc" : "Returns a reference to the linked element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] }, { "name" : "hasListener", @@ -72612,7 +190326,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "init", @@ -72620,7 +190358,37 @@ "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", "sig" : "(id, sGroup, config)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "initTarget", @@ -72628,7 +190396,37 @@ "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", "sig" : "(id, sGroup, config)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "isLocked", @@ -72636,7 +190434,24 @@ "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this obj or all drag/drop is locked, else\nfalse" + } + ] }, { "name" : "isTarget", @@ -72644,7 +190459,18 @@ "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValidHandleChild", @@ -72652,7 +190478,31 @@ "desc" : "Checks the tag exclusion list to see if this click should be ignored", "sig" : "(node)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "the HTMLElement to evaluate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this is a valid tag type, false if not" + } + ] }, { "name" : "lock", @@ -72660,7 +190510,18 @@ "desc" : "Lock this instance", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -72668,7 +190529,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onAvailable", @@ -72676,7 +190573,18 @@ "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "onDrag", @@ -72684,7 +190592,25 @@ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragDrop", @@ -72692,7 +190618,31 @@ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragEnter", @@ -72700,7 +190650,31 @@ "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragOut", @@ -72708,7 +190682,31 @@ "desc" : "Abstract method called when we are no longer hovering over an element", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragOver", @@ -72716,7 +190714,31 @@ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onInvalidDrop", @@ -72724,7 +190746,25 @@ "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onMouseDown", @@ -72732,7 +190772,25 @@ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousedown event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onMouseUp", @@ -72740,7 +190798,25 @@ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "padding", @@ -72748,7 +190824,18 @@ "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "purgeListeners", @@ -72756,7 +190843,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -72764,7 +190862,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "removeFromGroup", @@ -72772,7 +190888,25 @@ "desc" : "Remove's this instance from the supplied interaction group", "sig" : "(sGroup)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "string", + "desc" : "The group to drop", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleClass", @@ -72780,7 +190914,25 @@ "desc" : "Unsets an invalid css class", "sig" : "(cssClass)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the element(s) you wish to\nre-enable", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleId", @@ -72788,7 +190940,25 @@ "desc" : "Unsets an invalid handle id", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the id of the element to re-enable", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleType", @@ -72796,7 +190966,25 @@ "desc" : "Unsets an excluded tag name set by addInvalidHandleType", "sig" : "(tagName)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to unexclude", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeListener", @@ -72804,7 +190992,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "resetConstraints", @@ -72812,7 +191030,25 @@ "desc" : "resetConstraints must be called if you manually reposition a dd element.", "sig" : "(maintainOffset)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "maintainOffset", + "type" : "boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDragElId", @@ -72820,7 +191056,25 @@ "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setHandleElId", @@ -72828,7 +191082,25 @@ "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to\ninitiate the drag.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setInitPosition", @@ -72836,7 +191108,31 @@ "desc" : "Stores the initial placement of the linked element.", "sig" : "(diffX, diffY)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "diffX", + "type" : "int", + "desc" : "the X offset, default 0", + "isOptional" : false + }, + { + "name" : "diffY", + "type" : "int", + "desc" : "the Y offset, default 0", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setOuterHandleElId", @@ -72844,7 +191140,25 @@ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPadding", @@ -72852,7 +191166,43 @@ "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", "sig" : "(iTop, iRight, iBot, iLeft)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iTop", + "type" : "int", + "desc" : "Top pad", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "Right pad", + "isOptional" : false + }, + { + "name" : "iBot", + "type" : "int", + "desc" : "Bot pad", + "isOptional" : false + }, + { + "name" : "iLeft", + "type" : "int", + "desc" : "Left pad", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setXConstraint", @@ -72860,7 +191210,37 @@ "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", "sig" : "(iLeft, iRight, iTickSize)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iLeft", + "type" : "int", + "desc" : "the number of pixels the element can move to the left", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "the number of pixels the element can move to the\nright", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setYConstraint", @@ -72868,7 +191248,37 @@ "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", "sig" : "(iUp, iDown, iTickSize)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iUp", + "type" : "int", + "desc" : "the number of pixels the element can move up", + "isOptional" : false + }, + { + "name" : "iDown", + "type" : "int", + "desc" : "the number of pixels the element can move down", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "startDrag", @@ -72876,7 +191286,31 @@ "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", "sig" : "(X, Y)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "X", + "type" : "int", + "desc" : "click location", + "isOptional" : false + }, + { + "name" : "Y", + "type" : "int", + "desc" : "click location", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "toString", @@ -72884,7 +191318,24 @@ "desc" : "toString method", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "string", + "desc" : "string representation of the dd obj" + } + ] }, { "name" : "un", @@ -72892,7 +191343,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "unlock", @@ -72900,7 +191381,18 @@ "desc" : "Unlock this instace", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "unreg", @@ -72908,7 +191400,18 @@ "desc" : "Remove all drag and drop hooks for this element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -72929,7 +191432,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addInvalidHandleClass", @@ -72937,7 +191458,25 @@ "desc" : "Lets you specify a css class of elements that will not initiate a drag", "sig" : "(cssClass)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the elements you wish to ignore", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addInvalidHandleId", @@ -72945,7 +191484,25 @@ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the element id of the element you wish to ignore", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addInvalidHandleType", @@ -72953,7 +191510,25 @@ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", "sig" : "(tagName)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to exclude", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addListener", @@ -72961,7 +191536,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "addToGroup", @@ -72969,7 +191580,25 @@ "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", "sig" : "(sGroup)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "", + "desc" : "{string} the name of the group", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "applyConfig", @@ -72977,7 +191606,18 @@ "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -72985,7 +191625,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearConstraints", @@ -72993,7 +191663,18 @@ "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "clearTicks", @@ -73001,7 +191682,18 @@ "desc" : "Clears any tick interval defined for this instance", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "endDrag", @@ -73009,7 +191701,25 @@ "desc" : "Fired when we are done dragging the object", "sig" : "(e)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -73017,7 +191727,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getDragEl", @@ -73025,7 +191765,24 @@ "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] }, { "name" : "getEl", @@ -73033,7 +191790,24 @@ "desc" : "Returns a reference to the linked element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] }, { "name" : "hasListener", @@ -73041,7 +191815,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "init", @@ -73049,7 +191847,37 @@ "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", "sig" : "(id, sGroup, config)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "initTarget", @@ -73057,7 +191885,37 @@ "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", "sig" : "(id, sGroup, config)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "isLocked", @@ -73065,7 +191923,24 @@ "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this obj or all drag/drop is locked, else\nfalse" + } + ] }, { "name" : "isTarget", @@ -73073,7 +191948,18 @@ "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValidHandleChild", @@ -73081,7 +191967,31 @@ "desc" : "Checks the tag exclusion list to see if this click should be ignored", "sig" : "(node)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "the HTMLElement to evaluate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this is a valid tag type, false if not" + } + ] }, { "name" : "lock", @@ -73089,7 +191999,18 @@ "desc" : "Lock this instance", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -73097,7 +192018,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onAvailable", @@ -73105,7 +192062,18 @@ "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "onDrag", @@ -73113,7 +192081,25 @@ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", "sig" : "(e)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragDrop", @@ -73121,7 +192107,31 @@ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", "sig" : "(e, id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragEnter", @@ -73129,7 +192139,31 @@ "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", "sig" : "(e, id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragOut", @@ -73137,7 +192171,31 @@ "desc" : "Abstract method called when we are no longer hovering over an element", "sig" : "(e, id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragOver", @@ -73145,7 +192203,31 @@ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", "sig" : "(e, id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onInvalidDrop", @@ -73153,7 +192235,25 @@ "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", "sig" : "(e)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onMouseDown", @@ -73161,7 +192261,25 @@ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", "sig" : "(e)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousedown event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onMouseUp", @@ -73169,7 +192287,25 @@ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", "sig" : "(e)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "padding", @@ -73177,7 +192313,18 @@ "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "purgeListeners", @@ -73185,7 +192332,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -73193,7 +192351,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "removeFromGroup", @@ -73201,7 +192377,25 @@ "desc" : "Remove's this instance from the supplied interaction group", "sig" : "(sGroup)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "string", + "desc" : "The group to drop", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleClass", @@ -73209,7 +192403,25 @@ "desc" : "Unsets an invalid css class", "sig" : "(cssClass)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the element(s) you wish to\nre-enable", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleId", @@ -73217,7 +192429,25 @@ "desc" : "Unsets an invalid handle id", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the id of the element to re-enable", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleType", @@ -73225,7 +192455,25 @@ "desc" : "Unsets an excluded tag name set by addInvalidHandleType", "sig" : "(tagName)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to unexclude", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeListener", @@ -73233,7 +192481,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "resetConstraints", @@ -73241,7 +192519,25 @@ "desc" : "resetConstraints must be called if you manually reposition a dd element.", "sig" : "(maintainOffset)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "maintainOffset", + "type" : "boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDragElId", @@ -73249,7 +192545,25 @@ "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setHandleElId", @@ -73257,7 +192571,25 @@ "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to\ninitiate the drag.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setInitPosition", @@ -73265,7 +192597,31 @@ "desc" : "Stores the initial placement of the linked element.", "sig" : "(diffX, diffY)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "diffX", + "type" : "int", + "desc" : "the X offset, default 0", + "isOptional" : false + }, + { + "name" : "diffY", + "type" : "int", + "desc" : "the Y offset, default 0", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setOuterHandleElId", @@ -73273,7 +192629,25 @@ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPadding", @@ -73281,7 +192655,43 @@ "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", "sig" : "(iTop, iRight, iBot, iLeft)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iTop", + "type" : "int", + "desc" : "Top pad", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "Right pad", + "isOptional" : false + }, + { + "name" : "iBot", + "type" : "int", + "desc" : "Bot pad", + "isOptional" : false + }, + { + "name" : "iLeft", + "type" : "int", + "desc" : "Left pad", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setXConstraint", @@ -73289,7 +192699,37 @@ "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", "sig" : "(iLeft, iRight, iTickSize)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iLeft", + "type" : "int", + "desc" : "the number of pixels the element can move to the left", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "the number of pixels the element can move to the\nright", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setYConstraint", @@ -73297,7 +192737,37 @@ "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", "sig" : "(iUp, iDown, iTickSize)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iUp", + "type" : "int", + "desc" : "the number of pixels the element can move up", + "isOptional" : false + }, + { + "name" : "iDown", + "type" : "int", + "desc" : "the number of pixels the element can move down", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "startDrag", @@ -73305,7 +192775,31 @@ "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", "sig" : "(X, Y)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "X", + "type" : "int", + "desc" : "click location", + "isOptional" : false + }, + { + "name" : "Y", + "type" : "int", + "desc" : "click location", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "toString", @@ -73313,7 +192807,24 @@ "desc" : "toString method", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "string", + "desc" : "string representation of the dd obj" + } + ] }, { "name" : "un", @@ -73321,7 +192832,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "unlock", @@ -73329,7 +192870,18 @@ "desc" : "Unlock this instace", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "unreg", @@ -73337,7 +192889,18 @@ "desc" : "Remove all drag and drop hooks for this element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -73351,7 +192914,31 @@ "desc" : "Helper function for getting the best match from the list of drag\nand drop objects returned by the drag and drop events when we are\nin INTERSECT mode. It returns either the first object that the\ncursor is over, or the object that has the greatest overlap with\nthe dragged element.", "sig" : "(dds)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "dds", + "type" : "DragDrop[]", + "desc" : "The array of drag and drop objects\ntargeted", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "DragDrop", + "desc" : "The best single match" + } + ] }, { "name" : "getCss", @@ -73359,7 +192946,31 @@ "desc" : "Returns the style property for the DOM element (i.e.,\ndocument.getElById(id).style)", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "This has been deprecated: use Roo.getDom instead", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "the id of the elment to get", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The style property of the element" + } + ] }, { "name" : "getDDById", @@ -73367,7 +192978,31 @@ "desc" : "Returns the DragDrop instance for a given id", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "the id of the DragDrop object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "DragDrop", + "desc" : "the drag drop object, null if it is not found" + } + ] }, { "name" : "getElement", @@ -73375,7 +193010,31 @@ "desc" : "Returns the actual DOM element", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "This has been deprecated: use Roo.getDom instead", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "the id of the elment to get", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The element" + } + ] }, { "name" : "getLocation", @@ -73383,7 +193042,31 @@ "desc" : "Returns a Region object containing the drag and drop element's position\nand size, including the padding configured for it", "sig" : "(oDD)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "oDD", + "type" : "DragDrop", + "desc" : "the drag and drop object to get the\n location for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.lib.Region", + "desc" : "a Region object representing the total area\n the element occupies, including any padding\n the instance is configured for." + } + ] }, { "name" : "getPosX", @@ -73391,7 +193074,31 @@ "desc" : "Returns the X position of an html element", "sig" : "(el)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "This has been deprecated: use Roo.lib.Dom.getX instead", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "", + "desc" : "the element for which to get the position", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "int", + "desc" : "the X coordinate" + } + ] }, { "name" : "getPosY", @@ -73399,7 +193106,31 @@ "desc" : "Returns the Y position of an html element", "sig" : "(el)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "This has been deprecated: use Roo.lib.Dom.getY instead", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "", + "desc" : "the element for which to get the position", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "int", + "desc" : "the Y coordinate" + } + ] }, { "name" : "getRelated", @@ -73407,7 +193138,37 @@ "desc" : "Returns the drag and drop instances that are in all groups the\npassed in instance belongs to.", "sig" : "(p_oDD, bTargetsOnly)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "p_oDD", + "type" : "DragDrop", + "desc" : "the obj to get related data for", + "isOptional" : false + }, + { + "name" : "bTargetsOnly", + "type" : "boolean", + "desc" : "if true, only return targetable objs", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "DragDrop[]", + "desc" : "the related instances" + } + ] }, { "name" : "getScrollLeft", @@ -73415,7 +193176,24 @@ "desc" : "Gets the scrollLeft", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "int", + "desc" : "the document's scrollTop" + } + ] }, { "name" : "getScrollTop", @@ -73423,7 +193201,24 @@ "desc" : "Gets the scrollTop", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "int", + "desc" : "the document's scrollTop" + } + ] }, { "name" : "getStyle", @@ -73431,7 +193226,37 @@ "desc" : "Returns the specified element style property", "sig" : "(el, styleProp)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "This has been deprecated: use Roo.lib.Dom.getStyle", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "HTMLElement", + "desc" : "the element", + "isOptional" : false + }, + { + "name" : "styleProp", + "type" : "string", + "desc" : "the style property", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "string", + "desc" : "The value of the style property" + } + ] }, { "name" : "handleWasClicked", @@ -73439,7 +193264,25 @@ "desc" : "Recursively searches the immediate parent and all child nodes for\nthe handle element in order to determine wheter or not it was\nclicked.", "sig" : "(node)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "", + "desc" : "the html element to inspect", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "isDragDrop", @@ -73447,7 +193290,31 @@ "desc" : "Utility function to determine if a given element has been\nregistered as a drag drop item.", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "the element id to check", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this element is a DragDrop item,\nfalse otherwise" + } + ] }, { "name" : "isHandle", @@ -73455,7 +193322,31 @@ "desc" : "Utility function to determine if a given element has been\nregistered as a drag drop handle for the given Drag Drop object.", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "the element id to check", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this element is a DragDrop handle, false\notherwise" + } + ] }, { "name" : "isLegalTarget", @@ -73463,7 +193354,37 @@ "desc" : "Returns true if the specified dd target is a legal target for\nthe specifice drag obj", "sig" : "(the, the)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "DragDrop", + "desc" : "drag obj", + "isOptional" : false + }, + { + "name" : "the", + "type" : "DragDrop", + "desc" : "target", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if the target is a legal target for the\ndd obj" + } + ] }, { "name" : "isLocked", @@ -73471,7 +193392,24 @@ "desc" : "Is drag and drop locked?", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "True if drag and drop is locked, false otherwise." + } + ] }, { "name" : "isTypeOfDD", @@ -73479,7 +193417,31 @@ "desc" : "My goal is to be able to transparently determine if an object is\ntypeof DragDrop, and the exact subclass of DragDrop. typeof\nreturns \"object\", oDD.constructor.toString() always returns\n\"DragDrop\" and not the name of the subclass. So for now it just\nevaluates a well-known variable in DragDrop.", "sig" : "(the)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "the", + "type" : "Object", + "desc" : "object to evaluate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if typeof oDD = DragDrop" + } + ] }, { "name" : "lock", @@ -73487,7 +193449,18 @@ "desc" : "Lock all drag and drop functionality", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "moveToEl", @@ -73495,7 +193468,31 @@ "desc" : "Sets the x/y position of an element to the location of the\ntarget element.", "sig" : "(moveEl, targetEl)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "moveEl", + "type" : "HTMLElement", + "desc" : "The element to move", + "isOptional" : false + }, + { + "name" : "targetEl", + "type" : "HTMLElement", + "desc" : "The position reference element", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "numericSort", @@ -73503,7 +193500,18 @@ "desc" : "Numeric array sort function", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "refreshCache", @@ -73511,7 +193519,25 @@ "desc" : "Refreshes the cache of the top-left and bottom-right points of the\ndrag and drop objects in the specified group(s). This is in the\nformat that is stored in the drag and drop instance, so typical\nusage is:\n\nRoo.dd.DragDropMgr.refreshCache(ddinstance.groups);\n\nAlternatively:\n\nRoo.dd.DragDropMgr.refreshCache({group1:true, group2:true});\n", "sig" : "(groups)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "groups", + "type" : "Object", + "desc" : "an associative array of groups to refresh", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "regDragDrop", @@ -73519,7 +193545,31 @@ "desc" : "Each DragDrop instance must be registered with the DragDropMgr.\nThis is executed in DragDrop.init()", "sig" : "(oDD, sGroup)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "oDD", + "type" : "DragDrop", + "desc" : "the DragDrop object to register", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the name of the group this element belongs to", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "regHandle", @@ -73527,7 +193577,31 @@ "desc" : "Each DragDrop handle element must be registered. This is done\nautomatically when executing DragDrop.setHandleElId()", "sig" : "(sDDId, sHandleId)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "sDDId", + "type" : "String", + "desc" : "the DragDrop id this element is a handle for", + "isOptional" : false + }, + { + "name" : "sHandleId", + "type" : "String", + "desc" : "the id of the element that is the drag\nhandle", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "startDrag", @@ -73535,7 +193609,31 @@ "desc" : "Fired when either the drag pixel threshol or the mousedown hold\ntime threshold has been met.", "sig" : "(x, y)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "", + "desc" : "{int} the X position of the original mousedown", + "isOptional" : false + }, + { + "name" : "y", + "type" : "", + "desc" : "{int} the Y position of the original mousedown", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "stopEvent", @@ -73543,7 +193641,25 @@ "desc" : "Utility to stop event propagation and event default, if these\nfeatures are turned on.", "sig" : "(e)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the event as returned by this.getEvent()", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "swapNode", @@ -73551,7 +193667,31 @@ "desc" : "Swap two nodes. In IE, we use the native method, for others we\nemulate the IE behavior", "sig" : "(n1, n2)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "n1", + "type" : "", + "desc" : "the first node to swap", + "isOptional" : false + }, + { + "name" : "n2", + "type" : "", + "desc" : "the other node to swap", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "unlock", @@ -73559,7 +193699,18 @@ "desc" : "Unlock all drag and drop functionality", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "verifyEl", @@ -73567,7 +193718,31 @@ "desc" : "This checks to make sure an element exists and is in the DOM. The\nmain purpose is to handle cases where innerHTML is used to remove\ndrag and drop objects from the DOM. IE provides an 'unspecified\nerror' when trying to access the offsetParent of such an element", "sig" : "(el)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "HTMLElement", + "desc" : "the element to check", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if the element looks usable" + } + ] } ] }, @@ -73600,7 +193775,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addInvalidHandleClass", @@ -73608,7 +193801,25 @@ "desc" : "Lets you specify a css class of elements that will not initiate a drag", "sig" : "(cssClass)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the elements you wish to ignore", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addInvalidHandleId", @@ -73616,7 +193827,25 @@ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the element id of the element you wish to ignore", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addInvalidHandleType", @@ -73624,7 +193853,25 @@ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", "sig" : "(tagName)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to exclude", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addListener", @@ -73632,7 +193879,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "addToGroup", @@ -73640,7 +193923,25 @@ "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", "sig" : "(sGroup)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "", + "desc" : "{string} the name of the group", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "alignElWithMouse", @@ -73648,7 +193949,37 @@ "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", "sig" : "(el, iPageX, iPageY)", "static" : false, - "memberOf" : "Roo.dd.DD" + "memberOf" : "Roo.dd.DD", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "HTMLElement", + "desc" : "the element to move", + "isOptional" : false + }, + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the mousedown or drag event", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the mousedown or drag event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "applyConfig", @@ -73656,7 +193987,18 @@ "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "autoOffset", @@ -73664,7 +194006,31 @@ "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked", "sig" : "(iPageX, iPageY)", "static" : false, - "memberOf" : "Roo.dd.DD" + "memberOf" : "Roo.dd.DD", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the click", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the click", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeDragDrop", @@ -73672,7 +194038,43 @@ "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dropped onto the target and optionally cancel the onDragDrop.", "sig" : "(target, e, id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "target", + "type" : "Roo.dd.DragDrop", + "desc" : "The drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id of the dragged element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the drag drop event is valid, else false to cancel" + } + ] }, { "name" : "beforeDragEnter", @@ -73680,7 +194082,43 @@ "desc" : "An empty function by default, but provided so that you can perform a custom action\nbefore the dragged item enters the drop target and optionally cancel the onDragEnter.", "sig" : "(target, e, id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "target", + "type" : "Roo.dd.DragDrop", + "desc" : "The drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id of the dragged element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the drag event is valid, else false to cancel" + } + ] }, { "name" : "beforeDragOut", @@ -73688,7 +194126,43 @@ "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dragged out of the target without dropping, and optionally cancel the onDragOut.", "sig" : "(target, e, id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "target", + "type" : "Roo.dd.DragDrop", + "desc" : "The drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id of the dragged element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the drag event is valid, else false to cancel" + } + ] }, { "name" : "beforeDragOver", @@ -73696,7 +194170,43 @@ "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target and optionally cancel the onDragOver.", "sig" : "(target, e, id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "target", + "type" : "Roo.dd.DragDrop", + "desc" : "The drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id of the dragged element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the drag event is valid, else false to cancel" + } + ] }, { "name" : "beforeInvalidDrop", @@ -73704,7 +194214,43 @@ "desc" : "An empty function by default, but provided so that you can perform a custom action after an invalid\ndrop has occurred.", "sig" : "(target, e, id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "target", + "type" : "Roo.dd.DragDrop", + "desc" : "The drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id of the dragged element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the invalid drop should proceed, else false to cancel" + } + ] }, { "name" : "cachePosition", @@ -73712,7 +194258,31 @@ "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.", "sig" : "(iPageX, iPageY)", "static" : false, - "memberOf" : "Roo.dd.DD" + "memberOf" : "Roo.dd.DD", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "", + "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "", + "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "capture", @@ -73720,7 +194290,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearConstraints", @@ -73728,7 +194328,18 @@ "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "clearTicks", @@ -73736,7 +194347,18 @@ "desc" : "Clears any tick interval defined for this instance", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "createFrame", @@ -73744,7 +194366,18 @@ "desc" : "Creates the proxy element if it does not yet exist", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DDProxy" + "memberOf" : "Roo.dd.DDProxy", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "endDrag", @@ -73752,7 +194385,25 @@ "desc" : "Fired when we are done dragging the object", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -73760,7 +194411,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getDragData", @@ -73768,7 +194449,24 @@ "desc" : "Returns the data object associated with this drag source", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "data An object containing arbitrary data" + } + ] }, { "name" : "getDragEl", @@ -73776,7 +194474,24 @@ "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] }, { "name" : "getEl", @@ -73784,7 +194499,24 @@ "desc" : "Returns a reference to the linked element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] }, { "name" : "getProxy", @@ -73792,7 +194524,24 @@ "desc" : "Returns the drag source's underlying {@link Roo.dd.StatusProxy}", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.dd.StatusProxy", + "desc" : "proxy The StatusProxy" + } + ] }, { "name" : "hasListener", @@ -73800,7 +194549,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hideProxy", @@ -73808,7 +194581,18 @@ "desc" : "Hides the drag source's {@link Roo.dd.StatusProxy}", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "init", @@ -73816,7 +194600,37 @@ "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", "sig" : "(id, sGroup, config)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "initFrame", @@ -73824,7 +194638,18 @@ "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DDProxy" + "memberOf" : "Roo.dd.DDProxy", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initTarget", @@ -73832,7 +194657,37 @@ "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", "sig" : "(id, sGroup, config)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "isLocked", @@ -73840,7 +194695,24 @@ "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this obj or all drag/drop is locked, else\nfalse" + } + ] }, { "name" : "isTarget", @@ -73848,7 +194720,18 @@ "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValidHandleChild", @@ -73856,7 +194739,31 @@ "desc" : "Checks the tag exclusion list to see if this click should be ignored", "sig" : "(node)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "the HTMLElement to evaluate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this is a valid tag type, false if not" + } + ] }, { "name" : "lock", @@ -73864,7 +194771,18 @@ "desc" : "Lock this instance", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -73872,7 +194790,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onAvailable", @@ -73880,7 +194834,18 @@ "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "onBeforeDrag", @@ -73888,7 +194853,37 @@ "desc" : "An empty function by default, but provided so that you can perform a custom action before the initial\ndrag event begins and optionally cancel it.", "sig" : "(data, e)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data to be shared with drop targets", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the drag event is valid, else false to cancel" + } + ] }, { "name" : "onDrag", @@ -73896,7 +194891,25 @@ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragDrop", @@ -73904,7 +194917,31 @@ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragEnter", @@ -73912,7 +194949,31 @@ "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragOut", @@ -73920,7 +194981,31 @@ "desc" : "Abstract method called when we are no longer hovering over an element", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragOver", @@ -73928,7 +195013,31 @@ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onInvalidDrop", @@ -73936,7 +195045,25 @@ "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onMouseDown", @@ -73944,7 +195071,25 @@ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousedown event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onMouseUp", @@ -73952,7 +195097,25 @@ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onStartDrag", @@ -73960,7 +195123,31 @@ "desc" : "An empty function by default, but provided so that you can perform a custom action once the initial\ndrag event has begun. The drag cannot be canceled from this function.", "sig" : "(x, y)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The x position of the click on the dragged object", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The y position of the click on the dragged object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "padding", @@ -73968,7 +195155,18 @@ "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "purgeListeners", @@ -73976,7 +195174,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -73984,7 +195193,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "removeFromGroup", @@ -73992,7 +195219,25 @@ "desc" : "Remove's this instance from the supplied interaction group", "sig" : "(sGroup)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "string", + "desc" : "The group to drop", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleClass", @@ -74000,7 +195245,25 @@ "desc" : "Unsets an invalid css class", "sig" : "(cssClass)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the element(s) you wish to\nre-enable", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleId", @@ -74008,7 +195271,25 @@ "desc" : "Unsets an invalid handle id", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the id of the element to re-enable", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleType", @@ -74016,7 +195297,25 @@ "desc" : "Unsets an excluded tag name set by addInvalidHandleType", "sig" : "(tagName)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to unexclude", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeListener", @@ -74024,7 +195323,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "resetConstraints", @@ -74032,7 +195361,25 @@ "desc" : "resetConstraints must be called if you manually reposition a dd element.", "sig" : "(maintainOffset)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "maintainOffset", + "type" : "boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDelta", @@ -74040,7 +195387,31 @@ "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)", "sig" : "(iDeltaX, iDeltaY)", "static" : false, - "memberOf" : "Roo.dd.DD" + "memberOf" : "Roo.dd.DD", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iDeltaX", + "type" : "int", + "desc" : "the distance from the left", + "isOptional" : false + }, + { + "name" : "iDeltaY", + "type" : "int", + "desc" : "the distance from the top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDragElId", @@ -74048,7 +195419,25 @@ "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDragElPos", @@ -74056,7 +195445,31 @@ "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", "sig" : "(iPageX, iPageY)", "static" : false, - "memberOf" : "Roo.dd.DD" + "memberOf" : "Roo.dd.DD", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the mousedown or drag event", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the mousedown or drag event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setHandleElId", @@ -74064,7 +195477,25 @@ "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to\ninitiate the drag.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setInitPosition", @@ -74072,7 +195503,31 @@ "desc" : "Stores the initial placement of the linked element.", "sig" : "(diffX, diffY)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "diffX", + "type" : "int", + "desc" : "the X offset, default 0", + "isOptional" : false + }, + { + "name" : "diffY", + "type" : "int", + "desc" : "the Y offset, default 0", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setOuterHandleElId", @@ -74080,7 +195535,25 @@ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPadding", @@ -74088,7 +195561,43 @@ "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", "sig" : "(iTop, iRight, iBot, iLeft)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iTop", + "type" : "int", + "desc" : "Top pad", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "Right pad", + "isOptional" : false + }, + { + "name" : "iBot", + "type" : "int", + "desc" : "Bot pad", + "isOptional" : false + }, + { + "name" : "iLeft", + "type" : "int", + "desc" : "Left pad", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setXConstraint", @@ -74096,7 +195605,37 @@ "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", "sig" : "(iLeft, iRight, iTickSize)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iLeft", + "type" : "int", + "desc" : "the number of pixels the element can move to the left", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "the number of pixels the element can move to the\nright", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setYConstraint", @@ -74104,7 +195643,37 @@ "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", "sig" : "(iUp, iDown, iTickSize)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iUp", + "type" : "int", + "desc" : "the number of pixels the element can move up", + "isOptional" : false + }, + { + "name" : "iDown", + "type" : "int", + "desc" : "the number of pixels the element can move down", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "startDrag", @@ -74112,7 +195681,31 @@ "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", "sig" : "(X, Y)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "X", + "type" : "int", + "desc" : "click location", + "isOptional" : false + }, + { + "name" : "Y", + "type" : "int", + "desc" : "click location", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "toString", @@ -74120,7 +195713,24 @@ "desc" : "toString method", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "string", + "desc" : "string representation of the dd obj" + } + ] }, { "name" : "un", @@ -74128,7 +195738,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "unlock", @@ -74136,7 +195776,18 @@ "desc" : "Unlock this instace", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "unreg", @@ -74144,7 +195795,18 @@ "desc" : "Remove all drag and drop hooks for this element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -74189,7 +195851,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addInvalidHandleClass", @@ -74197,7 +195877,25 @@ "desc" : "Lets you specify a css class of elements that will not initiate a drag", "sig" : "(cssClass)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the elements you wish to ignore", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addInvalidHandleId", @@ -74205,7 +195903,25 @@ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the element id of the element you wish to ignore", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addInvalidHandleType", @@ -74213,7 +195929,25 @@ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", "sig" : "(tagName)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to exclude", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addListener", @@ -74221,7 +195955,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "addToGroup", @@ -74229,7 +195999,25 @@ "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", "sig" : "(sGroup)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "", + "desc" : "{string} the name of the group", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "afterRepair", @@ -74237,7 +196025,18 @@ "desc" : "Called after a repair of an invalid drop. By default, highlights this.dragData.ddel", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "alignElWithMouse", @@ -74245,7 +196044,37 @@ "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", "sig" : "(el, iPageX, iPageY)", "static" : false, - "memberOf" : "Roo.dd.DD" + "memberOf" : "Roo.dd.DD", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "HTMLElement", + "desc" : "the element to move", + "isOptional" : false + }, + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the mousedown or drag event", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the mousedown or drag event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "applyConfig", @@ -74253,7 +196082,18 @@ "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "autoOffset", @@ -74261,7 +196101,31 @@ "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked", "sig" : "(iPageX, iPageY)", "static" : false, - "memberOf" : "Roo.dd.DD" + "memberOf" : "Roo.dd.DD", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the click", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the click", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeDragDrop", @@ -74269,7 +196133,43 @@ "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dropped onto the target and optionally cancel the onDragDrop.", "sig" : "(target, e, id)", "static" : false, - "memberOf" : "Roo.dd.DragSource" + "memberOf" : "Roo.dd.DragSource", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "target", + "type" : "Roo.dd.DragDrop", + "desc" : "The drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id of the dragged element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the drag drop event is valid, else false to cancel" + } + ] }, { "name" : "beforeDragEnter", @@ -74277,7 +196177,43 @@ "desc" : "An empty function by default, but provided so that you can perform a custom action\nbefore the dragged item enters the drop target and optionally cancel the onDragEnter.", "sig" : "(target, e, id)", "static" : false, - "memberOf" : "Roo.dd.DragSource" + "memberOf" : "Roo.dd.DragSource", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "target", + "type" : "Roo.dd.DragDrop", + "desc" : "The drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id of the dragged element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the drag event is valid, else false to cancel" + } + ] }, { "name" : "beforeDragOut", @@ -74285,7 +196221,43 @@ "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dragged out of the target without dropping, and optionally cancel the onDragOut.", "sig" : "(target, e, id)", "static" : false, - "memberOf" : "Roo.dd.DragSource" + "memberOf" : "Roo.dd.DragSource", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "target", + "type" : "Roo.dd.DragDrop", + "desc" : "The drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id of the dragged element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the drag event is valid, else false to cancel" + } + ] }, { "name" : "beforeDragOver", @@ -74293,7 +196265,43 @@ "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target and optionally cancel the onDragOver.", "sig" : "(target, e, id)", "static" : false, - "memberOf" : "Roo.dd.DragSource" + "memberOf" : "Roo.dd.DragSource", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "target", + "type" : "Roo.dd.DragDrop", + "desc" : "The drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id of the dragged element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the drag event is valid, else false to cancel" + } + ] }, { "name" : "beforeInvalidDrop", @@ -74301,7 +196309,43 @@ "desc" : "An empty function by default, but provided so that you can perform a custom action after an invalid\ndrop has occurred.", "sig" : "(target, e, id)", "static" : false, - "memberOf" : "Roo.dd.DragSource" + "memberOf" : "Roo.dd.DragSource", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "target", + "type" : "Roo.dd.DragDrop", + "desc" : "The drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "The id of the dragged element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the invalid drop should proceed, else false to cancel" + } + ] }, { "name" : "cachePosition", @@ -74309,7 +196353,31 @@ "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.", "sig" : "(iPageX, iPageY)", "static" : false, - "memberOf" : "Roo.dd.DD" + "memberOf" : "Roo.dd.DD", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "", + "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "", + "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "capture", @@ -74317,7 +196385,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearConstraints", @@ -74325,7 +196423,18 @@ "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "clearTicks", @@ -74333,7 +196442,18 @@ "desc" : "Clears any tick interval defined for this instance", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "createFrame", @@ -74341,7 +196461,18 @@ "desc" : "Creates the proxy element if it does not yet exist", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DDProxy" + "memberOf" : "Roo.dd.DDProxy", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "endDrag", @@ -74349,7 +196480,25 @@ "desc" : "Fired when we are done dragging the object", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -74357,7 +196506,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getDragData", @@ -74365,7 +196544,31 @@ "desc" : "Called when a mousedown occurs in this container. Looks in {@link Roo.dd.Registry}\nfor a valid target to drag based on the mouse down. Override this method\nto provide your own lookup logic (e.g. finding a child by class name). Make sure your returned\nobject has a \"ddel\" attribute (with an HTML Element) for other functions to work.", "sig" : "(e)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "The mouse down event", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The dragData" + } + ] }, { "name" : "getDragEl", @@ -74373,7 +196576,24 @@ "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] }, { "name" : "getEl", @@ -74381,7 +196601,24 @@ "desc" : "Returns a reference to the linked element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] }, { "name" : "getProxy", @@ -74389,7 +196626,24 @@ "desc" : "Returns the drag source's underlying {@link Roo.dd.StatusProxy}", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragSource" + "memberOf" : "Roo.dd.DragSource", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.dd.StatusProxy", + "desc" : "proxy The StatusProxy" + } + ] }, { "name" : "getRepairXY", @@ -74397,7 +196651,31 @@ "desc" : "Called before a repair of an invalid drop to get the XY to animate to. By default returns\nthe XY of this.dragData.ddel", "sig" : "(e)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "The mouse up event", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The xy location (e.g. [100, 200])" + } + ] }, { "name" : "hasListener", @@ -74405,7 +196683,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hideProxy", @@ -74413,7 +196715,18 @@ "desc" : "Hides the drag source's {@link Roo.dd.StatusProxy}", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragSource" + "memberOf" : "Roo.dd.DragSource", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "init", @@ -74421,7 +196734,37 @@ "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", "sig" : "(id, sGroup, config)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "initFrame", @@ -74429,7 +196772,18 @@ "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DDProxy" + "memberOf" : "Roo.dd.DDProxy", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initTarget", @@ -74437,7 +196791,37 @@ "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", "sig" : "(id, sGroup, config)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "isLocked", @@ -74445,7 +196829,24 @@ "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this obj or all drag/drop is locked, else\nfalse" + } + ] }, { "name" : "isTarget", @@ -74453,7 +196854,18 @@ "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValidHandleChild", @@ -74461,7 +196873,31 @@ "desc" : "Checks the tag exclusion list to see if this click should be ignored", "sig" : "(node)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "the HTMLElement to evaluate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this is a valid tag type, false if not" + } + ] }, { "name" : "lock", @@ -74469,7 +196905,18 @@ "desc" : "Lock this instance", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -74477,7 +196924,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onAvailable", @@ -74485,7 +196968,18 @@ "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "onBeforeDrag", @@ -74493,7 +196987,37 @@ "desc" : "An empty function by default, but provided so that you can perform a custom action before the initial\ndrag event begins and optionally cancel it.", "sig" : "(data, e)", "static" : false, - "memberOf" : "Roo.dd.DragSource" + "memberOf" : "Roo.dd.DragSource", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data to be shared with drop targets", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "isValid True if the drag event is valid, else false to cancel" + } + ] }, { "name" : "onDrag", @@ -74501,7 +197025,25 @@ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragDrop", @@ -74509,7 +197051,31 @@ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragEnter", @@ -74517,7 +197083,31 @@ "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragOut", @@ -74525,7 +197115,31 @@ "desc" : "Abstract method called when we are no longer hovering over an element", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragOver", @@ -74533,7 +197147,31 @@ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onInitDrag", @@ -74541,7 +197179,37 @@ "desc" : "Called once drag threshold has been reached to initialize the proxy element. By default, it clones the\nthis.dragData.ddel", "sig" : "(x, y)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The x position of the click on the dragged object", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The y position of the click on the dragged object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "true to continue the drag, false to cancel" + } + ] }, { "name" : "onInvalidDrop", @@ -74549,7 +197217,25 @@ "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onMouseDown", @@ -74557,7 +197243,25 @@ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousedown event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onMouseUp", @@ -74565,7 +197269,25 @@ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onStartDrag", @@ -74573,7 +197295,31 @@ "desc" : "An empty function by default, but provided so that you can perform a custom action once the initial\ndrag event has begun. The drag cannot be canceled from this function.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.dd.DragSource" + "memberOf" : "Roo.dd.DragSource", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The x position of the click on the dragged object", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The y position of the click on the dragged object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "padding", @@ -74581,7 +197327,18 @@ "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "purgeListeners", @@ -74589,7 +197346,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -74597,7 +197365,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "removeFromGroup", @@ -74605,7 +197391,25 @@ "desc" : "Remove's this instance from the supplied interaction group", "sig" : "(sGroup)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "string", + "desc" : "The group to drop", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleClass", @@ -74613,7 +197417,25 @@ "desc" : "Unsets an invalid css class", "sig" : "(cssClass)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the element(s) you wish to\nre-enable", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleId", @@ -74621,7 +197443,25 @@ "desc" : "Unsets an invalid handle id", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the id of the element to re-enable", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleType", @@ -74629,7 +197469,25 @@ "desc" : "Unsets an excluded tag name set by addInvalidHandleType", "sig" : "(tagName)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to unexclude", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeListener", @@ -74637,7 +197495,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "resetConstraints", @@ -74645,7 +197533,25 @@ "desc" : "resetConstraints must be called if you manually reposition a dd element.", "sig" : "(maintainOffset)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "maintainOffset", + "type" : "boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDelta", @@ -74653,7 +197559,31 @@ "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)", "sig" : "(iDeltaX, iDeltaY)", "static" : false, - "memberOf" : "Roo.dd.DD" + "memberOf" : "Roo.dd.DD", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iDeltaX", + "type" : "int", + "desc" : "the distance from the left", + "isOptional" : false + }, + { + "name" : "iDeltaY", + "type" : "int", + "desc" : "the distance from the top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDragElId", @@ -74661,7 +197591,25 @@ "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDragElPos", @@ -74669,7 +197617,31 @@ "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", "sig" : "(iPageX, iPageY)", "static" : false, - "memberOf" : "Roo.dd.DD" + "memberOf" : "Roo.dd.DD", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the mousedown or drag event", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the mousedown or drag event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setHandleElId", @@ -74677,7 +197649,25 @@ "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to\ninitiate the drag.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setInitPosition", @@ -74685,7 +197675,31 @@ "desc" : "Stores the initial placement of the linked element.", "sig" : "(diffX, diffY)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "diffX", + "type" : "int", + "desc" : "the X offset, default 0", + "isOptional" : false + }, + { + "name" : "diffY", + "type" : "int", + "desc" : "the Y offset, default 0", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setOuterHandleElId", @@ -74693,7 +197707,25 @@ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPadding", @@ -74701,7 +197733,43 @@ "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", "sig" : "(iTop, iRight, iBot, iLeft)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iTop", + "type" : "int", + "desc" : "Top pad", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "Right pad", + "isOptional" : false + }, + { + "name" : "iBot", + "type" : "int", + "desc" : "Bot pad", + "isOptional" : false + }, + { + "name" : "iLeft", + "type" : "int", + "desc" : "Left pad", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setXConstraint", @@ -74709,7 +197777,37 @@ "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", "sig" : "(iLeft, iRight, iTickSize)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iLeft", + "type" : "int", + "desc" : "the number of pixels the element can move to the left", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "the number of pixels the element can move to the\nright", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setYConstraint", @@ -74717,7 +197815,37 @@ "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", "sig" : "(iUp, iDown, iTickSize)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iUp", + "type" : "int", + "desc" : "the number of pixels the element can move up", + "isOptional" : false + }, + { + "name" : "iDown", + "type" : "int", + "desc" : "the number of pixels the element can move down", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "startDrag", @@ -74725,7 +197853,31 @@ "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", "sig" : "(X, Y)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "X", + "type" : "int", + "desc" : "click location", + "isOptional" : false + }, + { + "name" : "Y", + "type" : "int", + "desc" : "click location", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "toString", @@ -74733,7 +197885,24 @@ "desc" : "toString method", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "string", + "desc" : "string representation of the dd obj" + } + ] }, { "name" : "un", @@ -74741,7 +197910,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "unlock", @@ -74749,7 +197948,18 @@ "desc" : "Unlock this instace", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "unreg", @@ -74757,7 +197967,18 @@ "desc" : "Remove all drag and drop hooks for this element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -74812,28 +198033,128 @@ "type" : "function", "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has\nbeen dropped on it. This method has no default implementation and returns false, so you must provide an\nimplementation that does something to process the drop event and returns true so that the drag source's\nrepair action does not run.\n\nIMPORTANT : it should set this.success", "sig" : "function (source, e, data)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enter", "type" : "function", "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.valid to true|false", "sig" : "function (source, e, data)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "out", "type" : "function", "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged\nout of the target without dropping. This default implementation simply removes the CSS class specified by\noverClass (if any) from the drop element.", "sig" : "function (source, e, data)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "over", "type" : "function", "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.valid to true|false", "sig" : "function (source, e, data)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -74843,7 +198164,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addInvalidHandleClass", @@ -74851,7 +198190,25 @@ "desc" : "Lets you specify a css class of elements that will not initiate a drag", "sig" : "(cssClass)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the elements you wish to ignore", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addInvalidHandleId", @@ -74859,7 +198216,25 @@ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the element id of the element you wish to ignore", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addInvalidHandleType", @@ -74867,7 +198242,25 @@ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", "sig" : "(tagName)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to exclude", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addListener", @@ -74875,7 +198268,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "addToGroup", @@ -74883,7 +198312,25 @@ "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", "sig" : "(sGroup)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "", + "desc" : "{string} the name of the group", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "applyConfig", @@ -74891,7 +198338,18 @@ "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -74899,7 +198357,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearConstraints", @@ -74907,7 +198395,18 @@ "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "clearTicks", @@ -74915,7 +198414,18 @@ "desc" : "Clears any tick interval defined for this instance", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "endDrag", @@ -74923,7 +198433,25 @@ "desc" : "Fired when we are done dragging the object", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -74931,7 +198459,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getDragEl", @@ -74939,7 +198497,24 @@ "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] }, { "name" : "getEl", @@ -74947,7 +198522,24 @@ "desc" : "Returns a reference to the linked element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] }, { "name" : "hasListener", @@ -74955,7 +198547,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "init", @@ -74963,7 +198579,37 @@ "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", "sig" : "(id, sGroup, config)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "initTarget", @@ -74971,7 +198617,37 @@ "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", "sig" : "(id, sGroup, config)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "isLocked", @@ -74979,7 +198655,24 @@ "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this obj or all drag/drop is locked, else\nfalse" + } + ] }, { "name" : "isTarget", @@ -74987,7 +198680,18 @@ "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValidHandleChild", @@ -74995,7 +198699,31 @@ "desc" : "Checks the tag exclusion list to see if this click should be ignored", "sig" : "(node)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "the HTMLElement to evaluate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this is a valid tag type, false if not" + } + ] }, { "name" : "lock", @@ -75003,7 +198731,18 @@ "desc" : "Lock this instance", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "notifyDrop", @@ -75011,7 +198750,18 @@ "desc" : "", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "notifyEnter", @@ -75019,7 +198769,18 @@ "desc" : "", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "notifyOut", @@ -75027,7 +198788,18 @@ "desc" : "", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "notifyOver", @@ -75035,7 +198807,18 @@ "desc" : "", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -75043,7 +198826,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onAvailable", @@ -75051,7 +198870,18 @@ "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "onDrag", @@ -75059,7 +198889,25 @@ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragDrop", @@ -75067,7 +198915,31 @@ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragEnter", @@ -75075,7 +198947,31 @@ "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragOut", @@ -75083,7 +198979,31 @@ "desc" : "Abstract method called when we are no longer hovering over an element", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragOver", @@ -75091,7 +199011,31 @@ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onInvalidDrop", @@ -75099,7 +199043,25 @@ "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onMouseDown", @@ -75107,7 +199069,25 @@ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousedown event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onMouseUp", @@ -75115,7 +199095,25 @@ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "padding", @@ -75123,7 +199121,18 @@ "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "purgeListeners", @@ -75131,7 +199140,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -75139,7 +199159,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "removeFromGroup", @@ -75147,7 +199185,25 @@ "desc" : "Remove's this instance from the supplied interaction group", "sig" : "(sGroup)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "string", + "desc" : "The group to drop", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleClass", @@ -75155,7 +199211,25 @@ "desc" : "Unsets an invalid css class", "sig" : "(cssClass)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the element(s) you wish to\nre-enable", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleId", @@ -75163,7 +199237,25 @@ "desc" : "Unsets an invalid handle id", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the id of the element to re-enable", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleType", @@ -75171,7 +199263,25 @@ "desc" : "Unsets an excluded tag name set by addInvalidHandleType", "sig" : "(tagName)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to unexclude", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeListener", @@ -75179,7 +199289,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "resetConstraints", @@ -75187,7 +199327,25 @@ "desc" : "resetConstraints must be called if you manually reposition a dd element.", "sig" : "(maintainOffset)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "maintainOffset", + "type" : "boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDragElId", @@ -75195,7 +199353,25 @@ "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setHandleElId", @@ -75203,7 +199379,25 @@ "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to\ninitiate the drag.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setInitPosition", @@ -75211,7 +199405,31 @@ "desc" : "Stores the initial placement of the linked element.", "sig" : "(diffX, diffY)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "diffX", + "type" : "int", + "desc" : "the X offset, default 0", + "isOptional" : false + }, + { + "name" : "diffY", + "type" : "int", + "desc" : "the Y offset, default 0", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setOuterHandleElId", @@ -75219,7 +199437,25 @@ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPadding", @@ -75227,7 +199463,43 @@ "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", "sig" : "(iTop, iRight, iBot, iLeft)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iTop", + "type" : "int", + "desc" : "Top pad", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "Right pad", + "isOptional" : false + }, + { + "name" : "iBot", + "type" : "int", + "desc" : "Bot pad", + "isOptional" : false + }, + { + "name" : "iLeft", + "type" : "int", + "desc" : "Left pad", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setXConstraint", @@ -75235,7 +199507,37 @@ "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", "sig" : "(iLeft, iRight, iTickSize)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iLeft", + "type" : "int", + "desc" : "the number of pixels the element can move to the left", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "the number of pixels the element can move to the\nright", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setYConstraint", @@ -75243,7 +199545,37 @@ "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", "sig" : "(iUp, iDown, iTickSize)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iUp", + "type" : "int", + "desc" : "the number of pixels the element can move up", + "isOptional" : false + }, + { + "name" : "iDown", + "type" : "int", + "desc" : "the number of pixels the element can move down", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "startDrag", @@ -75251,7 +199583,31 @@ "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", "sig" : "(X, Y)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "X", + "type" : "int", + "desc" : "click location", + "isOptional" : false + }, + { + "name" : "Y", + "type" : "int", + "desc" : "click location", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "toString", @@ -75259,7 +199615,24 @@ "desc" : "toString method", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "string", + "desc" : "string representation of the dd obj" + } + ] }, { "name" : "un", @@ -75267,7 +199640,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "unlock", @@ -75275,7 +199678,18 @@ "desc" : "Unlock this instace", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "unreg", @@ -75283,7 +199697,18 @@ "desc" : "Remove all drag and drop hooks for this element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -75338,28 +199763,128 @@ "type" : "function", "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has\nbeen dropped on it. This method has no default implementation and returns false, so you must provide an\nimplementation that does something to process the drop event and returns true so that the drag source's\nrepair action does not run.\n\nIMPORTANT : it should set this.success", "sig" : "function (source, e, data)\n{\n\n}", - "memberOf" : "Roo.dd.DropTarget" + "memberOf" : "Roo.dd.DropTarget", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enter", "type" : "function", "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.valid to true|false", "sig" : "function (source, e, data)\n{\n\n}", - "memberOf" : "Roo.dd.DropTarget" + "memberOf" : "Roo.dd.DropTarget", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "out", "type" : "function", "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged\nout of the target without dropping. This default implementation simply removes the CSS class specified by\noverClass (if any) from the drop element.", "sig" : "function (source, e, data)\n{\n\n}", - "memberOf" : "Roo.dd.DropTarget" + "memberOf" : "Roo.dd.DropTarget", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "over", "type" : "function", "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.valid to true|false", "sig" : "function (source, e, data)\n{\n\n}", - "memberOf" : "Roo.dd.DropTarget" + "memberOf" : "Roo.dd.DropTarget", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -75369,7 +199894,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addInvalidHandleClass", @@ -75377,7 +199920,25 @@ "desc" : "Lets you specify a css class of elements that will not initiate a drag", "sig" : "(cssClass)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the elements you wish to ignore", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addInvalidHandleId", @@ -75385,7 +199946,25 @@ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the element id of the element you wish to ignore", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addInvalidHandleType", @@ -75393,7 +199972,25 @@ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", "sig" : "(tagName)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to exclude", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addListener", @@ -75401,7 +199998,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "addToGroup", @@ -75409,7 +200042,25 @@ "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", "sig" : "(sGroup)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "", + "desc" : "{string} the name of the group", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "applyConfig", @@ -75417,7 +200068,18 @@ "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -75425,7 +200087,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearConstraints", @@ -75433,7 +200125,18 @@ "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "clearTicks", @@ -75441,7 +200144,18 @@ "desc" : "Clears any tick interval defined for this instance", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "endDrag", @@ -75449,7 +200163,25 @@ "desc" : "Fired when we are done dragging the object", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -75457,7 +200189,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getDragEl", @@ -75465,7 +200227,24 @@ "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] }, { "name" : "getEl", @@ -75473,7 +200252,24 @@ "desc" : "Returns a reference to the linked element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] }, { "name" : "getTargetFromEvent", @@ -75481,7 +200277,31 @@ "desc" : "Returns a custom data object associated with the DOM node that is the target of the event. By default\nthis looks up the event target in the {@link Roo.dd.Registry}, although you can override this method to\nprovide your own custom lookup.", "sig" : "(e)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "data The custom data" + } + ] }, { "name" : "hasListener", @@ -75489,7 +200309,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "init", @@ -75497,7 +200341,37 @@ "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", "sig" : "(id, sGroup, config)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "initTarget", @@ -75505,7 +200379,37 @@ "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", "sig" : "(id, sGroup, config)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "isLocked", @@ -75513,7 +200417,24 @@ "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this obj or all drag/drop is locked, else\nfalse" + } + ] }, { "name" : "isTarget", @@ -75521,7 +200442,18 @@ "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValidHandleChild", @@ -75529,7 +200461,31 @@ "desc" : "Checks the tag exclusion list to see if this click should be ignored", "sig" : "(node)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "the HTMLElement to evaluate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this is a valid tag type, false if not" + } + ] }, { "name" : "lock", @@ -75537,7 +200493,18 @@ "desc" : "Lock this instance", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "notifyDrop", @@ -75545,7 +200512,43 @@ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the dragged item has\nbeen dropped on it. The drag zone will look up the target node based on the event passed in, and if there\nis a node registered for that event, it will delegate to {@link #onNodeDrop} for node-specific handling,\notherwise it will call {@link #onContainerDrop}.", "sig" : "(source, e, data)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop zone", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the drop was valid, else false" + } + ] }, { "name" : "notifyEnter", @@ -75553,7 +200556,43 @@ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source is now over\nthe zone. The default implementation returns this.dropNotAllowed and expects that only registered drop\nnodes can process drag drop operations, so if you need the drop zone itself to be able to process drops\nyou should override this method and provide a custom implementation.", "sig" : "(source, e, data)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop zone", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated" + } + ] }, { "name" : "notifyOut", @@ -75561,7 +200600,37 @@ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source has been dragged\nout of the zone without dropping. If the drag source is currently over a registered node, the notification\nwill be delegated to {@link #onNodeOut} for node-specific handling, otherwise it will be ignored.", "sig" : "(source, e, data)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop target", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag zone", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "notifyOver", @@ -75569,7 +200638,43 @@ "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the drop zone.\nThis method will be called on every mouse movement while the drag source is over the drop zone.\nIt will call {@link #onNodeOver} while the drag source is over a registered node, and will also automatically\ndelegate to the appropriate node-specific methods as necessary when the drag source enters and exits\nregistered nodes ({@link #onNodeEnter}, {@link #onNodeOut}). If the drag source is not currently over a\nregistered node, it will call {@link #onContainerOver}.", "sig" : "(source, e, data)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop zone", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated" + } + ] }, { "name" : "on", @@ -75577,7 +200682,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onAvailable", @@ -75585,7 +200726,18 @@ "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "onContainerDrop", @@ -75593,7 +200745,43 @@ "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped on it,\nbut not on any of its registered drop nodes. The default implementation returns false, so it should be\noverridden to provide the appropriate processing of the drop event if you need the drop zone itself to\nbe able to accept drops. It should return true when valid so that the drag source's repair action does not run.", "sig" : "(source, e, data)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop zone", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the drop was valid, else false" + } + ] }, { "name" : "onContainerOver", @@ -75601,7 +200789,43 @@ "desc" : "Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is being dragged over it,\nbut not over any of its registered drop nodes. The default implementation returns this.dropNotAllowed, so\nit should be overridden to provide the proper feedback if necessary.", "sig" : "(source, e, data)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop zone", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated" + } + ] }, { "name" : "onDrag", @@ -75609,7 +200833,25 @@ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragDrop", @@ -75617,7 +200859,31 @@ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragEnter", @@ -75625,7 +200891,31 @@ "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragOut", @@ -75633,7 +200923,31 @@ "desc" : "Abstract method called when we are no longer hovering over an element", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragOver", @@ -75641,7 +200955,31 @@ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onInvalidDrop", @@ -75649,7 +200987,25 @@ "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onMouseDown", @@ -75657,7 +201013,25 @@ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousedown event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onMouseUp", @@ -75665,7 +201039,25 @@ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onNodeDrop", @@ -75673,7 +201065,49 @@ "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped onto\nthe drop node. The default implementation returns false, so it should be overridden to provide the\nappropriate processing of the drop event and return true so that the drag source's repair action does not run.", "sig" : "(nodeData, source, e, data)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "nodeData", + "type" : "Object", + "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)", + "isOptional" : false + }, + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop zone", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the drop was valid, else false" + } + ] }, { "name" : "onNodeEnter", @@ -75681,7 +201115,43 @@ "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has entered a drop node\nthat it has registered. This method has no default implementation and should be overridden to provide\nnode-specific processing if necessary.", "sig" : "(nodeData, source, e, data)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "nodeData", + "type" : "Object", + "desc" : "The custom data associated with the drop node (this is the same value returned from \n{@link #getTargetFromEvent} for this node)", + "isOptional" : false + }, + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop zone", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onNodeOut", @@ -75689,7 +201159,43 @@ "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dragged out of\nthe drop node without dropping. This method has no default implementation and should be overridden to provide\nnode-specific processing if necessary.", "sig" : "(nodeData, source, e, data)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "nodeData", + "type" : "Object", + "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)", + "isOptional" : false + }, + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop zone", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onNodeOver", @@ -75697,7 +201203,49 @@ "desc" : "Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is over a drop node\nthat it has registered. The default implementation returns this.dropNotAllowed, so it should be\noverridden to provide the proper feedback.", "sig" : "(nodeData, source, e, data)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "nodeData", + "type" : "Object", + "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)", + "isOptional" : false + }, + { + "name" : "source", + "type" : "Roo.dd.DragSource", + "desc" : "The drag source that was dragged over this drop zone", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "An object containing arbitrary data supplied by the drag source", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated" + } + ] }, { "name" : "padding", @@ -75705,7 +201253,18 @@ "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "purgeListeners", @@ -75713,7 +201272,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -75721,7 +201291,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "removeFromGroup", @@ -75729,7 +201317,25 @@ "desc" : "Remove's this instance from the supplied interaction group", "sig" : "(sGroup)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "string", + "desc" : "The group to drop", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleClass", @@ -75737,7 +201343,25 @@ "desc" : "Unsets an invalid css class", "sig" : "(cssClass)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the element(s) you wish to\nre-enable", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleId", @@ -75745,7 +201369,25 @@ "desc" : "Unsets an invalid handle id", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the id of the element to re-enable", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleType", @@ -75753,7 +201395,25 @@ "desc" : "Unsets an excluded tag name set by addInvalidHandleType", "sig" : "(tagName)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to unexclude", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeListener", @@ -75761,7 +201421,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "resetConstraints", @@ -75769,7 +201459,25 @@ "desc" : "resetConstraints must be called if you manually reposition a dd element.", "sig" : "(maintainOffset)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "maintainOffset", + "type" : "boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDragElId", @@ -75777,7 +201485,25 @@ "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setHandleElId", @@ -75785,7 +201511,25 @@ "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to\ninitiate the drag.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setInitPosition", @@ -75793,7 +201537,31 @@ "desc" : "Stores the initial placement of the linked element.", "sig" : "(diffX, diffY)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "diffX", + "type" : "int", + "desc" : "the X offset, default 0", + "isOptional" : false + }, + { + "name" : "diffY", + "type" : "int", + "desc" : "the Y offset, default 0", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setOuterHandleElId", @@ -75801,7 +201569,25 @@ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPadding", @@ -75809,7 +201595,43 @@ "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", "sig" : "(iTop, iRight, iBot, iLeft)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iTop", + "type" : "int", + "desc" : "Top pad", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "Right pad", + "isOptional" : false + }, + { + "name" : "iBot", + "type" : "int", + "desc" : "Bot pad", + "isOptional" : false + }, + { + "name" : "iLeft", + "type" : "int", + "desc" : "Left pad", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setXConstraint", @@ -75817,7 +201639,37 @@ "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", "sig" : "(iLeft, iRight, iTickSize)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iLeft", + "type" : "int", + "desc" : "the number of pixels the element can move to the left", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "the number of pixels the element can move to the\nright", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setYConstraint", @@ -75825,7 +201677,37 @@ "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", "sig" : "(iUp, iDown, iTickSize)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iUp", + "type" : "int", + "desc" : "the number of pixels the element can move up", + "isOptional" : false + }, + { + "name" : "iDown", + "type" : "int", + "desc" : "the number of pixels the element can move down", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "startDrag", @@ -75833,7 +201715,31 @@ "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", "sig" : "(X, Y)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "X", + "type" : "int", + "desc" : "click location", + "isOptional" : false + }, + { + "name" : "Y", + "type" : "int", + "desc" : "click location", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "toString", @@ -75841,7 +201747,24 @@ "desc" : "toString method", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "string", + "desc" : "string representation of the dd obj" + } + ] }, { "name" : "un", @@ -75849,7 +201772,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "unlock", @@ -75857,7 +201810,18 @@ "desc" : "Unlock this instace", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "unreg", @@ -75865,7 +201829,18 @@ "desc" : "Remove all drag and drop hooks for this element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -75879,7 +201854,31 @@ "desc" : "Returns the handle registered for a DOM Node by id", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String|HTMLElement", + "desc" : "The DOM node or id to look up", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "handle The custom handle data" + } + ] }, { "name" : "getHandleFromEvent", @@ -75887,7 +201886,31 @@ "desc" : "Returns the handle that is registered for the DOM node that is the target of the event", "sig" : "(e)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "handle The custom handle data" + } + ] }, { "name" : "getTarget", @@ -75895,7 +201918,31 @@ "desc" : "Returns a custom data object that is registered for a DOM node by id", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String|HTMLElement", + "desc" : "The DOM node or id to look up", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "data The custom data" + } + ] }, { "name" : "getTargetFromEvent", @@ -75903,7 +201950,31 @@ "desc" : "Returns a custom data object that is registered for the DOM node that is the target of the event", "sig" : "(e)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "The event", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "data The custom data" + } + ] }, { "name" : "register", @@ -75911,7 +201982,31 @@ "desc" : "Register a drag drop element", "sig" : "(element, data)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "element", + "type" : "String|HTMLElement", + "desc" : "The id or DOM node to register", + "isOptional" : false + }, + { + "name" : "data", + "type" : "Object", + "desc" : "(optional) A custom data object that will be passed between the elements that are involved\nin drag drop operations. You can populate this object with any arbitrary properties that your own code\nknows how to interpret, plus there are some specific properties known to the Registry that should be\npopulated in the data object (if applicable):\n
\nValue      Description
\n--------- ------------------------------------------
\nhandles Array of DOM nodes that trigger dragging
\n for the element being registered
\nisHandle True if the element passed in triggers
\n dragging itself, else false\n
", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "unregister", @@ -75919,7 +202014,25 @@ "desc" : "Unregister a drag drop element", "sig" : "(element)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "element", + "type" : "String|HTMLElement", + "desc" : "The id or DOM node to unregister", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -75933,7 +202046,18 @@ "desc" : "Manually trigger a cache refresh.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "register", @@ -75941,7 +202065,25 @@ "desc" : "Registers new overflow element(s) to auto scroll", "sig" : "(el)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element/Array", + "desc" : "The id of or the element to be scrolled or an array of either", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "unregister", @@ -75949,7 +202091,25 @@ "desc" : "Unregisters overflow element(s) so they are no longer scrolled", "sig" : "(el)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element/Array", + "desc" : "The id of or the element to be removed or an array of either", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -75976,7 +202136,24 @@ "desc" : "Returns the underlying proxy {@link Roo.Layer}", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Layer", + "desc" : "el" + } + ] }, { "name" : "getGhost", @@ -75984,7 +202161,24 @@ "desc" : "Returns the ghost element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "el" + } + ] }, { "name" : "hide", @@ -75992,7 +202186,25 @@ "desc" : "Hides the proxy", "sig" : "(clear)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "clear", + "type" : "Boolean", + "desc" : "True to reset the status and clear the ghost contents, false to preserve them", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "repair", @@ -76000,7 +202212,37 @@ "desc" : "Causes the proxy to return to its position of origin via an animation. Should be called after an\ninvalid drop operation by the item being dragged.", "sig" : "(xy, callback, scope)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "xy", + "type" : "Array", + "desc" : "The XY position of the element ([x, y])", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "The function to call after the repair is complete", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "The scope in which to execute the callback", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "reset", @@ -76008,7 +202250,25 @@ "desc" : "Resets the status indicator to the default dropNotAllowed value", "sig" : "(clearGhost)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "clearGhost", + "type" : "Boolean", + "desc" : "True to also remove all content from the ghost, false to preserve it", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setStatus", @@ -76016,7 +202276,25 @@ "desc" : "Updates the proxy's visual element to indicate the status of whether or not drop is allowed\nover the current target element.", "sig" : "(cssClass)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "String", + "desc" : "The css class for the new drop status indicator image", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", @@ -76024,7 +202302,18 @@ "desc" : "Displays this proxy", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "stop", @@ -76032,7 +202321,18 @@ "desc" : "Stops the repair animation if it's currently running", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "sync", @@ -76040,7 +202340,18 @@ "desc" : "Force the Layer to sync its shadow and shim positions to the element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "update", @@ -76048,7 +202359,25 @@ "desc" : "Updates the contents of the ghost element", "sig" : "(html)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "html", + "type" : "String", + "desc" : "The html that will replace the current innerHTML of the ghost element", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -76074,11 +202403,7 @@ "name" : "errorMask", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "errorReader", @@ -76141,21 +202466,78 @@ "type" : "function", "desc" : "Fires when an action is completed.", "sig" : "function (_self, action)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Form", + "desc" : "", + "isOptional" : false + }, + { + "name" : "action", + "type" : "Action", + "desc" : "The action that completed", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "actionfailed", "type" : "function", "desc" : "Fires when an action fails.", "sig" : "function (_self, action)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Form", + "desc" : "", + "isOptional" : false + }, + { + "name" : "action", + "type" : "Action", + "desc" : "The action that failed", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeaction", "type" : "function", "desc" : "Fires before any action is performed. Return false to cancel the action.", "sig" : "function (_self, action)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Form", + "desc" : "", + "isOptional" : false + }, + { + "name" : "action", + "type" : "Action", + "desc" : "The action to be performed", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -76165,7 +202547,43 @@ "desc" : "Add Roo.form components to this form.", "sig" : "(field1, field2, etc)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "field1", + "type" : "Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "field2", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + }, + { + "name" : "etc", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "addEvents", @@ -76173,7 +202591,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addForm", @@ -76181,7 +202617,25 @@ "desc" : "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms.", "sig" : "(form)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "form", + "type" : "Roo.form.Form", + "desc" : "to add.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addListener", @@ -76189,7 +202643,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "applyIfToFields", @@ -76197,7 +202687,31 @@ "desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.", "sig" : "(values)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "values", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "applyToFields", @@ -76205,7 +202719,31 @@ "desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.", "sig" : "(values)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "values", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "capture", @@ -76213,7 +202751,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -76221,7 +202789,24 @@ "desc" : "Clears all invalid messages in this form.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "doAction", @@ -76229,7 +202814,37 @@ "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.", "sig" : "(actionName, options)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "actionName", + "type" : "String", + "desc" : "The name of the action type", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) The options to pass to the action. All of the config options listed\nbelow are supported by both the submit and load actions unless otherwise noted (custom actions could also\naccept other config options):\n
\nProperty          Type             Description\n----------------  ---------------  ----------------------------------------------------------------------------------\nurl               String           The url for the action (defaults to the form's url)\nmethod            String           The form method to use (defaults to the form's method, or POST if not defined)\nparams            String/Object    The params to pass (defaults to the form's baseParams, or none if not defined)\nclientValidation  Boolean          Applies to submit only.  Pass true to call form.isValid() prior to posting to\n                                   validate the form on the client (defaults to false)\n
", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "findField", @@ -76237,7 +202852,31 @@ "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The value to search for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Field" + } + ] }, { "name" : "fireEvent", @@ -76245,7 +202884,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getFieldValues", @@ -76253,7 +202922,24 @@ "desc" : "Returns the fields in this form as an object with key/value pairs. \nThis differs from getValues as it calls getValue on each child item, rather than using dom data.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "" + } + ] }, { "name" : "getValues", @@ -76261,7 +202947,31 @@ "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.", "sig" : "(asString)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "asString", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "" + } + ] }, { "name" : "hasChanged", @@ -76269,7 +202979,24 @@ "desc" : "Returns true if any fields in this form have changed since their original load. (New version)", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] }, { "name" : "hasListener", @@ -76277,7 +203004,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "invalidFields", @@ -76285,7 +203036,24 @@ "desc" : "Returns array of invalid form fields.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Array" + } + ] }, { "name" : "isDirty", @@ -76293,7 +203061,24 @@ "desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] }, { "name" : "isValid", @@ -76301,7 +203086,24 @@ "desc" : "Returns true if client-side validation on the form is successful.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] }, { "name" : "load", @@ -76309,7 +203111,31 @@ "desc" : "Shortcut to do a load action.", "sig" : "(options)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "The options to pass to the action (see {@link #doAction} for details)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "loadRecord", @@ -76317,7 +203143,31 @@ "desc" : "Loads an Roo.data.Record into this form.", "sig" : "(record)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "record", + "type" : "Record", + "desc" : "The record to load", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "markInvalid", @@ -76325,7 +203175,31 @@ "desc" : "Mark fields in this form invalid in bulk.", "sig" : "(errors)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "errors", + "type" : "Array/Object", + "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "on", @@ -76333,7 +203207,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -76341,7 +203251,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -76349,7 +203270,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "remove", @@ -76357,7 +203296,31 @@ "desc" : "Removes a field from the items collection (does NOT remove its markup).", "sig" : "(field)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "field", + "type" : "Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "removeListener", @@ -76365,7 +203328,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -76373,7 +203366,24 @@ "desc" : "Looks at the fields in this form, checks them for an id attribute,\nand calls applyTo on the existing dom element with that id.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "reset", @@ -76381,7 +203391,24 @@ "desc" : "Resets this form.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "resetHasChanged", @@ -76389,7 +203416,24 @@ "desc" : "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] }, { "name" : "setValues", @@ -76397,7 +203441,31 @@ "desc" : "Set values for fields in this form in bulk.", "sig" : "(values)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "values", + "type" : "Array/Object", + "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "submit", @@ -76405,7 +203473,31 @@ "desc" : "Shortcut to do a submit action.", "sig" : "(options)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "The options to pass to the action (see {@link #doAction} for details)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "un", @@ -76413,7 +203505,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateRecord", @@ -76421,7 +203543,31 @@ "desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.", "sig" : "(record)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "record", + "type" : "Record", + "desc" : "The record to edit", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] } ] }, @@ -76503,11 +203649,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "inputType", @@ -76618,140 +203760,472 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "check", "type" : "function", "desc" : "Fires when the checkbox is checked or unchecked.", "sig" : "function (_self, checked)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Checkbox", + "desc" : "This checkbox", + "isOptional" : false + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "The new checked value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires after the component is moved.", "sig" : "function (_self, x, y)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires after the component is resized.", "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -76761,7 +204235,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -76769,7 +204261,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "applyTo", @@ -76777,7 +204305,31 @@ "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", "sig" : "(el)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] }, { "name" : "capture", @@ -76785,7 +204337,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -76793,7 +204375,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -76801,7 +204394,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -76809,7 +204413,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -76817,7 +204438,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -76825,7 +204463,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -76833,7 +204501,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getBox", @@ -76841,7 +204533,25 @@ "desc" : "Gets the current box measurements of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -76849,7 +204559,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -76857,7 +204584,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -76865,7 +204609,24 @@ "desc" : "Returns the name attribute of the field if available", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] }, { "name" : "getPosition", @@ -76873,7 +204634,31 @@ "desc" : "Gets the current XY position of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] }, { "name" : "getRawValue", @@ -76881,7 +204666,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getSize", @@ -76889,7 +204691,24 @@ "desc" : "Gets the current size of the component's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] }, { "name" : "getValue", @@ -76897,7 +204716,24 @@ "desc" : "Returns the checked state of the checkbox.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if checked, else false" + } + ] }, { "name" : "hasChanged", @@ -76905,7 +204741,18 @@ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -76913,7 +204760,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -76921,7 +204792,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isDirty", @@ -76929,7 +204817,18 @@ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValid", @@ -76937,7 +204836,31 @@ "desc" : "Returns whether or not the field value is currently valid", "sig" : "(preventMark)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "isVisible", @@ -76945,7 +204868,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -76953,7 +204887,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -76961,7 +204913,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onPosition", @@ -76969,7 +204957,31 @@ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onResize", @@ -76977,7 +204989,43 @@ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -76985,7 +205033,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -76993,7 +205052,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -77001,7 +205078,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -77009,7 +205116,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -77017,7 +205142,18 @@ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "resetHasChanged", @@ -77025,7 +205161,18 @@ "desc" : "stores the current value in loadedValue", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setDisabled", @@ -77033,7 +205180,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setPagePosition", @@ -77041,7 +205206,31 @@ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPosition", @@ -77049,7 +205238,31 @@ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", "sig" : "(left, top)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRawValue", @@ -77057,7 +205270,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setSize", @@ -77065,7 +205296,37 @@ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] }, { "name" : "setValue", @@ -77073,7 +205334,31 @@ "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.", "sig" : "(value, suppressEvent)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Boolean/String", + "desc" : "- the value to set", + "isOptional" : false + }, + { + "name" : "suppressEvent", + "type" : "Boolean/String", + "desc" : "- whether to suppress the checkchange event.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -77081,7 +205366,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -77089,7 +205398,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "syncSize", @@ -77097,7 +205423,18 @@ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -77105,7 +205442,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateBox", @@ -77113,7 +205480,25 @@ "desc" : "Sets the current box measurements of the component's underlying element.", "sig" : "(box)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "validate", @@ -77121,7 +205506,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -77167,11 +205569,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "labelAlign", @@ -77216,70 +205614,200 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -77289,7 +205817,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -77297,7 +205843,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "addxtype", @@ -77305,7 +205887,25 @@ "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column", "sig" : "(config)", "static" : false, - "memberOf" : "Roo.form.Layout" + "memberOf" : "Roo.form.Layout", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "capture", @@ -77313,7 +205913,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -77321,7 +205951,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -77329,7 +205970,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -77337,7 +205995,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -77345,7 +206020,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -77353,7 +206058,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getEl", @@ -77361,7 +206090,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -77369,7 +206115,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -77377,7 +206140,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -77385,7 +206172,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isVisible", @@ -77393,7 +206197,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -77401,7 +206216,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -77409,7 +206260,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -77417,7 +206279,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -77425,7 +206305,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -77433,7 +206343,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -77441,7 +206369,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisible", @@ -77449,7 +206395,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -77457,7 +206427,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "un", @@ -77465,7 +206452,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -77637,11 +206654,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "hideTrigger", @@ -77956,189 +206969,666 @@ "type" : "function", "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "autosize", "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", "sig" : "function (_self, width)\n{\n\n}", - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforequery", "type" : "function", "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:", "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "query", + "type" : "String", + "desc" : "The query", + "isOptional" : false + }, + { + "name" : "forceAll", + "type" : "Boolean", + "desc" : "true to force \"all\" query", + "isOptional" : false + }, + { + "name" : "cancel", + "type" : "Boolean", + "desc" : "true to cancel the query", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "The query event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeselect", "type" : "function", "desc" : "Fires before a list item is selected. Return false to cancel the selection.", "sig" : "function (combo, record, index)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The data record returned from the underlying store", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the selected item in the dropdown list", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "collapse", "type" : "function", "desc" : "Fires when the dropdown list is collapsed", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "edit", "type" : "function", "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)", "sig" : "function (combo, record)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record|false", + "desc" : "The data record returned from the underlying store (or false on nothing selected)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enable", "type" : "function", "desc" : "Fires after the component is enabled.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "expand", "type" : "function", "desc" : "Fires when the dropdown list is expanded", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires after the component is moved.", "sig" : "function (_self, x, y)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires after the component is resized.", "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "select", "type" : "function", "desc" : "Fires when a list item is selected", "sig" : "function (combo, record, index)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The data record returned from the underlying store (or false on clear)", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the selected item in the dropdown list", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -78148,7 +207638,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -78156,7 +207664,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "applyTo", @@ -78164,7 +207708,31 @@ "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", "sig" : "(el)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] }, { "name" : "autoSize", @@ -78172,7 +207740,18 @@ "desc" : "", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.TriggerField" + "memberOf" : "Roo.form.TriggerField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -78180,7 +207759,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -78188,7 +207797,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "clearValue", @@ -78196,7 +207816,18 @@ "desc" : "Clears any text/value currently set in the field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "collapse", @@ -78204,7 +207835,18 @@ "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -78212,7 +207854,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -78220,7 +207873,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "doQuery", @@ -78228,7 +207898,31 @@ "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.", "sig" : "(query, forceAll)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "query", + "type" : "String", + "desc" : "The SQL query to execute", + "isOptional" : false + }, + { + "name" : "forceAll", + "type" : "Boolean", + "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enable", @@ -78236,7 +207930,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "expand", @@ -78244,7 +207955,18 @@ "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -78252,7 +207974,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -78260,7 +208012,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getBox", @@ -78268,7 +208044,25 @@ "desc" : "Gets the current box measurements of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -78276,7 +208070,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -78284,7 +208095,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -78292,7 +208120,24 @@ "desc" : "Returns the name attribute of the field if available", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] }, { "name" : "getPosition", @@ -78300,7 +208145,31 @@ "desc" : "Gets the current XY position of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] }, { "name" : "getRawValue", @@ -78308,7 +208177,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getSize", @@ -78316,7 +208202,24 @@ "desc" : "Gets the current size of the component's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] }, { "name" : "getValue", @@ -78324,7 +208227,24 @@ "desc" : "Returns the currently selected field value or empty string if no value is set.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "value The selected value" + } + ] }, { "name" : "hasChanged", @@ -78332,7 +208252,18 @@ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -78340,7 +208271,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -78348,7 +208303,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isDirty", @@ -78356,7 +208328,18 @@ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isExpanded", @@ -78364,7 +208347,18 @@ "desc" : "Returns true if the dropdown list is expanded, else false.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValid", @@ -78372,7 +208366,31 @@ "desc" : "Returns whether or not the field value is currently valid", "sig" : "(preventMark)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "isVisible", @@ -78380,7 +208398,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -78388,7 +208417,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -78396,7 +208443,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onPosition", @@ -78404,7 +208487,31 @@ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onResize", @@ -78412,7 +208519,43 @@ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onTriggerClick", @@ -78420,7 +208563,25 @@ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.form.TriggerField" + "memberOf" : "Roo.form.TriggerField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -78428,7 +208589,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -78436,7 +208608,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -78444,7 +208634,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -78452,7 +208672,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -78460,7 +208698,18 @@ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "resetHasChanged", @@ -78468,7 +208717,18 @@ "desc" : "stores the current value in loadedValue", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "select", @@ -78476,7 +208736,31 @@ "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", "sig" : "(index, scrollIntoView)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The zero-based index of the list item to select", + "isOptional" : false + }, + { + "name" : "scrollIntoView", + "type" : "Boolean", + "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "selectByValue", @@ -78484,7 +208768,37 @@ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", "sig" : "(value, scrollIntoView)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The data value of the item to select", + "isOptional" : false + }, + { + "name" : "scrollIntoView", + "type" : "Boolean", + "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value matched an item in the list, else false" + } + ] }, { "name" : "selectText", @@ -78492,7 +208806,31 @@ "desc" : "Selects text in this field", "sig" : "(start, end)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDisabled", @@ -78500,7 +208838,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setEditable", @@ -78508,7 +208864,25 @@ "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Boolean", + "desc" : "True to allow the user to directly edit the field text", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setFromData", @@ -78516,7 +208890,25 @@ "desc" : "Sets the value of the field based on a object which is related to the record format for the store.", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Object", + "desc" : "the value to set as. or false on reset?", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPagePosition", @@ -78524,7 +208916,31 @@ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPosition", @@ -78532,7 +208948,31 @@ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", "sig" : "(left, top)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRawValue", @@ -78540,7 +208980,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setSize", @@ -78548,7 +209006,37 @@ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] }, { "name" : "setValue", @@ -78556,7 +209044,25 @@ "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The value to match", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -78564,7 +209070,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -78572,7 +209102,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "syncSize", @@ -78580,7 +209127,18 @@ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -78588,7 +209146,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateBox", @@ -78596,7 +209184,25 @@ "desc" : "Sets the current box measurements of the component's underlying element.", "sig" : "(box)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "validate", @@ -78604,7 +209210,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -78612,7 +209235,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -78662,8 +209309,8 @@ }, { "name" : "combo", - "type" : "Roo.form.Combo", - "desc" : "The combo box that is wrapped", + "type" : "Roo.form.ComboBox", + "desc" : "[required] The combo box that is wrapped", "memberOf" : "" }, { @@ -78742,11 +209389,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "inputType", @@ -78911,154 +209554,524 @@ "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", "sig" : "function (_self, width)\n{\n\n}", - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeremove", "type" : "function", "desc" : "Fires before remove the value from the list", "sig" : "function (_self, item)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "_self", + "type" : "Roo.form.ComboBoxArray", + "desc" : "This combo box array", + "isOptional" : false + }, + { + "name" : "item", + "type" : "Roo.form.ComboBoxArray.Item", + "desc" : "removed item", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires after the component is moved.", "sig" : "function (_self, x, y)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "remove", "type" : "function", "desc" : "Fires when remove the value from the list", "sig" : "function (_self, item)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "_self", + "type" : "Roo.form.ComboBoxArray", + "desc" : "This combo box array", + "isOptional" : false + }, + { + "name" : "item", + "type" : "Roo.form.ComboBoxArray.Item", + "desc" : "removed item", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires after the component is resized.", "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -79068,7 +210081,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -79076,7 +210107,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "applyTo", @@ -79084,7 +210151,31 @@ "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", "sig" : "(el)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] }, { "name" : "autoSize", @@ -79092,7 +210183,18 @@ "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -79100,7 +210202,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -79108,7 +210240,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -79116,7 +210259,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -79124,7 +210278,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -79132,7 +210303,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -79140,7 +210328,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -79148,7 +210366,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getBox", @@ -79156,7 +210398,25 @@ "desc" : "Gets the current box measurements of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -79164,7 +210424,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -79172,7 +210449,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -79180,7 +210474,24 @@ "desc" : "Returns the name attribute of the field if available", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] }, { "name" : "getPosition", @@ -79188,7 +210499,31 @@ "desc" : "Gets the current XY position of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] }, { "name" : "getRawValue", @@ -79196,7 +210531,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getSize", @@ -79204,7 +210556,24 @@ "desc" : "Gets the current size of the component's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] }, { "name" : "getValue", @@ -79212,7 +210581,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "hasChanged", @@ -79220,7 +210606,18 @@ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -79228,7 +210625,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -79236,7 +210657,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isDirty", @@ -79244,7 +210682,18 @@ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValid", @@ -79252,7 +210701,31 @@ "desc" : "Returns whether or not the field value is currently valid", "sig" : "(preventMark)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "isVisible", @@ -79260,7 +210733,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -79268,7 +210752,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -79276,7 +210778,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onPosition", @@ -79284,7 +210822,31 @@ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onResize", @@ -79292,7 +210854,43 @@ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -79300,7 +210898,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -79308,7 +210917,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -79316,7 +210943,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -79324,7 +210981,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -79332,7 +211007,18 @@ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "resetHasChanged", @@ -79340,7 +211026,18 @@ "desc" : "stores the current value in loadedValue", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "selectText", @@ -79348,7 +211045,31 @@ "desc" : "Selects text in this field", "sig" : "(start, end)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDisabled", @@ -79356,7 +211077,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setPagePosition", @@ -79364,7 +211103,31 @@ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPosition", @@ -79372,7 +211135,31 @@ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", "sig" : "(left, top)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRawValue", @@ -79380,7 +211167,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setSize", @@ -79388,7 +211193,37 @@ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] }, { "name" : "setValue", @@ -79396,7 +211231,25 @@ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -79404,7 +211257,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -79412,7 +211289,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "syncSize", @@ -79420,7 +211314,18 @@ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -79428,7 +211333,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateBox", @@ -79436,7 +211371,25 @@ "desc" : "Sets the current box measurements of the component's underlying element.", "sig" : "(box)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "validate", @@ -79444,7 +211397,24 @@ "desc" : "Validates the combox array value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -79452,7 +211422,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -79486,11 +211480,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -79511,84 +211501,276 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires after the component is moved.", "sig" : "function (_self, x, y)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires after the component is resized.", "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -79598,7 +211780,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -79606,7 +211806,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -79614,7 +211850,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -79622,7 +211888,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -79630,7 +211907,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -79638,7 +211932,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -79646,7 +211957,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -79654,7 +211995,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getBox", @@ -79662,7 +212027,25 @@ "desc" : "Gets the current box measurements of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -79670,7 +212053,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -79678,7 +212078,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getPosition", @@ -79686,7 +212103,31 @@ "desc" : "Gets the current XY position of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] }, { "name" : "getSize", @@ -79694,7 +212135,24 @@ "desc" : "Gets the current size of the component's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] }, { "name" : "hasListener", @@ -79702,7 +212160,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -79710,7 +212192,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isVisible", @@ -79718,7 +212217,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -79726,7 +212236,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onPosition", @@ -79734,7 +212280,31 @@ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onResize", @@ -79742,7 +212312,43 @@ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -79750,7 +212356,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -79758,7 +212375,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -79766,7 +212401,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -79774,7 +212439,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -79782,7 +212465,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setPagePosition", @@ -79790,7 +212491,31 @@ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPosition", @@ -79798,7 +212523,31 @@ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", "sig" : "(left, top)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setSize", @@ -79806,7 +212555,37 @@ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] }, { "name" : "setVisible", @@ -79814,7 +212593,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -79822,7 +212625,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "syncSize", @@ -79830,7 +212650,18 @@ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -79838,7 +212669,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateBox", @@ -79846,7 +212707,25 @@ "desc" : "Sets the current box measurements of the component's underlying element.", "sig" : "(box)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -80018,11 +212897,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "hideTrigger", @@ -80337,189 +213212,666 @@ "type" : "function", "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "autosize", "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", "sig" : "function (_self, width)\n{\n\n}", - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforequery", "type" : "function", "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:", "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}", - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "query", + "type" : "String", + "desc" : "The query", + "isOptional" : false + }, + { + "name" : "forceAll", + "type" : "Boolean", + "desc" : "true to force \"all\" query", + "isOptional" : false + }, + { + "name" : "cancel", + "type" : "Boolean", + "desc" : "true to cancel the query", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "The query event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeselect", "type" : "function", "desc" : "Fires before a list item is selected. Return false to cancel the selection.", "sig" : "function (combo, record, index)\n{\n\n}", - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The data record returned from the underlying store", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the selected item in the dropdown list", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "collapse", "type" : "function", "desc" : "Fires when the dropdown list is collapsed", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "edit", "type" : "function", "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)", "sig" : "function (combo, record)\n{\n\n}", - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record|false", + "desc" : "The data record returned from the underlying store (or false on nothing selected)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enable", "type" : "function", "desc" : "Fires after the component is enabled.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "expand", "type" : "function", "desc" : "Fires when the dropdown list is expanded", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires after the component is moved.", "sig" : "function (_self, x, y)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires after the component is resized.", "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "select", "type" : "function", "desc" : "Fires when a list item is selected", "sig" : "function (combo, record, index)\n{\n\n}", - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The data record returned from the underlying store (or false on clear)", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the selected item in the dropdown list", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -80529,7 +213881,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -80537,7 +213907,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "applyTo", @@ -80545,7 +213951,31 @@ "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", "sig" : "(el)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] }, { "name" : "autoSize", @@ -80553,7 +213983,18 @@ "desc" : "", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.TriggerField" + "memberOf" : "Roo.form.TriggerField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -80561,7 +214002,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -80569,7 +214040,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "clearValue", @@ -80577,7 +214059,18 @@ "desc" : "Clears any text/value currently set in the field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "collapse", @@ -80585,7 +214078,18 @@ "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -80593,7 +214097,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -80601,7 +214116,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "doQuery", @@ -80609,7 +214141,31 @@ "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.", "sig" : "(query, forceAll)", "static" : false, - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "query", + "type" : "String", + "desc" : "The SQL query to execute", + "isOptional" : false + }, + { + "name" : "forceAll", + "type" : "Boolean", + "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enable", @@ -80617,7 +214173,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "expand", @@ -80625,7 +214198,18 @@ "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -80633,7 +214217,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -80641,7 +214255,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getBox", @@ -80649,7 +214287,25 @@ "desc" : "Gets the current box measurements of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -80657,7 +214313,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -80665,7 +214338,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -80673,7 +214363,24 @@ "desc" : "Returns the name attribute of the field if available", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] }, { "name" : "getPosition", @@ -80681,7 +214388,31 @@ "desc" : "Gets the current XY position of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] }, { "name" : "getRawValue", @@ -80689,7 +214420,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getSize", @@ -80697,7 +214445,24 @@ "desc" : "Gets the current size of the component's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] }, { "name" : "getValue", @@ -80705,7 +214470,24 @@ "desc" : "Returns the currently selected field value or empty string if no value is set.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "value The selected value" + } + ] }, { "name" : "hasChanged", @@ -80713,7 +214495,18 @@ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -80721,7 +214514,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -80729,7 +214546,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isDirty", @@ -80737,7 +214571,18 @@ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isExpanded", @@ -80745,7 +214590,18 @@ "desc" : "Returns true if the dropdown list is expanded, else false.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValid", @@ -80753,7 +214609,31 @@ "desc" : "Returns whether or not the field value is currently valid", "sig" : "(preventMark)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "isVisible", @@ -80761,7 +214641,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -80769,7 +214660,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -80777,7 +214686,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onPosition", @@ -80785,7 +214730,31 @@ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onResize", @@ -80793,7 +214762,43 @@ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onTriggerClick", @@ -80801,7 +214806,25 @@ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.form.TriggerField" + "memberOf" : "Roo.form.TriggerField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -80809,7 +214832,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -80817,7 +214851,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -80825,7 +214877,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -80833,7 +214915,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -80841,7 +214941,18 @@ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "resetHasChanged", @@ -80849,7 +214960,18 @@ "desc" : "stores the current value in loadedValue", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "select", @@ -80857,7 +214979,31 @@ "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", "sig" : "(index, scrollIntoView)", "static" : false, - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The zero-based index of the list item to select", + "isOptional" : false + }, + { + "name" : "scrollIntoView", + "type" : "Boolean", + "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "selectByValue", @@ -80865,7 +215011,37 @@ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", "sig" : "(value, scrollIntoView)", "static" : false, - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The data value of the item to select", + "isOptional" : false + }, + { + "name" : "scrollIntoView", + "type" : "Boolean", + "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value matched an item in the list, else false" + } + ] }, { "name" : "selectText", @@ -80873,7 +215049,31 @@ "desc" : "Selects text in this field", "sig" : "(start, end)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDisabled", @@ -80881,7 +215081,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setEditable", @@ -80889,7 +215107,25 @@ "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Boolean", + "desc" : "True to allow the user to directly edit the field text", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setFromData", @@ -80897,7 +215133,25 @@ "desc" : "Sets the value of the field based on a object which is related to the record format for the store.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Object", + "desc" : "the value to set as. or false on reset?", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPagePosition", @@ -80905,7 +215159,31 @@ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPosition", @@ -80913,7 +215191,31 @@ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", "sig" : "(left, top)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRawValue", @@ -80921,7 +215223,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setSize", @@ -80929,7 +215249,37 @@ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] }, { "name" : "setValue", @@ -80937,7 +215287,25 @@ "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The value to match", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -80945,7 +215313,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -80953,7 +215345,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "syncSize", @@ -80961,7 +215370,18 @@ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -80969,7 +215389,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateBox", @@ -80977,7 +215427,25 @@ "desc" : "Sets the current box measurements of the component's underlying element.", "sig" : "(box)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "validate", @@ -80985,7 +215453,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -80993,7 +215478,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -81165,11 +215674,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "hideTrigger", @@ -81484,189 +215989,666 @@ "type" : "function", "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "autosize", "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", "sig" : "function (_self, width)\n{\n\n}", - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforequery", "type" : "function", "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:", "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}", - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "query", + "type" : "String", + "desc" : "The query", + "isOptional" : false + }, + { + "name" : "forceAll", + "type" : "Boolean", + "desc" : "true to force \"all\" query", + "isOptional" : false + }, + { + "name" : "cancel", + "type" : "Boolean", + "desc" : "true to cancel the query", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Object", + "desc" : "The query event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeselect", "type" : "function", "desc" : "Fires before a list item is selected. Return false to cancel the selection.", "sig" : "function (combo, record, index)\n{\n\n}", - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The data record returned from the underlying store", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the selected item in the dropdown list", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "collapse", "type" : "function", "desc" : "Fires when the dropdown list is collapsed", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "edit", "type" : "function", "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)", "sig" : "function (combo, record)\n{\n\n}", - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record|false", + "desc" : "The data record returned from the underlying store (or false on nothing selected)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enable", "type" : "function", "desc" : "Fires after the component is enabled.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "expand", "type" : "function", "desc" : "Fires when the dropdown list is expanded", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires after the component is moved.", "sig" : "function (_self, x, y)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires after the component is resized.", "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "select", "type" : "function", "desc" : "Fires when a list item is selected", "sig" : "function (combo, record, index)\n{\n\n}", - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record", + "desc" : "The data record returned from the underlying store (or false on clear)", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the selected item in the dropdown list", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -81676,7 +216658,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -81684,7 +216684,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "applyTo", @@ -81692,7 +216728,31 @@ "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", "sig" : "(el)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] }, { "name" : "autoSize", @@ -81700,7 +216760,18 @@ "desc" : "", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.TriggerField" + "memberOf" : "Roo.form.TriggerField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -81708,7 +216779,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -81716,7 +216817,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "clearValue", @@ -81724,7 +216836,18 @@ "desc" : "Clears any text/value currently set in the field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "collapse", @@ -81732,7 +216855,18 @@ "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -81740,7 +216874,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -81748,7 +216893,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "doQuery", @@ -81756,7 +216918,31 @@ "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.", "sig" : "(query, forceAll)", "static" : false, - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "query", + "type" : "String", + "desc" : "The SQL query to execute", + "isOptional" : false + }, + { + "name" : "forceAll", + "type" : "Boolean", + "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enable", @@ -81764,7 +216950,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "expand", @@ -81772,7 +216975,18 @@ "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -81780,7 +216994,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -81788,7 +217032,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getBox", @@ -81796,7 +217064,25 @@ "desc" : "Gets the current box measurements of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -81804,7 +217090,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -81812,7 +217115,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -81820,7 +217140,24 @@ "desc" : "Returns the name attribute of the field if available", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] }, { "name" : "getPosition", @@ -81828,7 +217165,31 @@ "desc" : "Gets the current XY position of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] }, { "name" : "getRawValue", @@ -81836,7 +217197,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getSize", @@ -81844,7 +217222,24 @@ "desc" : "Gets the current size of the component's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] }, { "name" : "getValue", @@ -81852,7 +217247,24 @@ "desc" : "Returns the currently selected field value or empty string if no value is set.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "value The selected value" + } + ] }, { "name" : "hasChanged", @@ -81860,7 +217272,18 @@ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -81868,7 +217291,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -81876,7 +217323,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isDirty", @@ -81884,7 +217348,18 @@ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isExpanded", @@ -81892,7 +217367,18 @@ "desc" : "Returns true if the dropdown list is expanded, else false.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValid", @@ -81900,7 +217386,31 @@ "desc" : "Returns whether or not the field value is currently valid", "sig" : "(preventMark)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "isVisible", @@ -81908,7 +217418,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -81916,7 +217437,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -81924,7 +217463,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onPosition", @@ -81932,7 +217507,31 @@ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onResize", @@ -81940,7 +217539,43 @@ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onTriggerClick", @@ -81948,7 +217583,25 @@ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.form.TriggerField" + "memberOf" : "Roo.form.TriggerField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -81956,7 +217609,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -81964,7 +217628,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -81972,7 +217654,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -81980,7 +217692,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -81988,7 +217718,18 @@ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "resetHasChanged", @@ -81996,7 +217737,18 @@ "desc" : "stores the current value in loadedValue", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "select", @@ -82004,7 +217756,31 @@ "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", "sig" : "(index, scrollIntoView)", "static" : false, - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The zero-based index of the list item to select", + "isOptional" : false + }, + { + "name" : "scrollIntoView", + "type" : "Boolean", + "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "selectByValue", @@ -82012,7 +217788,37 @@ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", "sig" : "(value, scrollIntoView)", "static" : false, - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The data value of the item to select", + "isOptional" : false + }, + { + "name" : "scrollIntoView", + "type" : "Boolean", + "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value matched an item in the list, else false" + } + ] }, { "name" : "selectText", @@ -82020,7 +217826,31 @@ "desc" : "Selects text in this field", "sig" : "(start, end)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDisabled", @@ -82028,7 +217858,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setEditable", @@ -82036,7 +217884,25 @@ "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Boolean", + "desc" : "True to allow the user to directly edit the field text", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setFromData", @@ -82044,7 +217910,25 @@ "desc" : "Sets the value of the field based on a object which is related to the record format for the store.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Object", + "desc" : "the value to set as. or false on reset?", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPagePosition", @@ -82052,7 +217936,31 @@ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPosition", @@ -82060,7 +217968,31 @@ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", "sig" : "(left, top)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRawValue", @@ -82068,7 +218000,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setSize", @@ -82076,7 +218026,37 @@ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] }, { "name" : "setValue", @@ -82084,7 +218064,25 @@ "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.ComboBox" + "memberOf" : "Roo.form.ComboBox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The value to match", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -82092,7 +218090,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -82100,7 +218122,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "syncSize", @@ -82108,7 +218147,18 @@ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -82116,7 +218166,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateBox", @@ -82124,7 +218204,25 @@ "desc" : "Sets the current box measurements of the component's underlying element.", "sig" : "(box)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "validate", @@ -82132,7 +218230,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -82140,7 +218255,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -82276,11 +218415,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "hideTrigger", @@ -82481,147 +218616,498 @@ "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", "sig" : "function (_self, width)\n{\n\n}", - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires after the component is moved.", "sig" : "function (_self, x, y)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires after the component is resized.", "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "select", "type" : "function", "desc" : "Fires when a date is selected", "sig" : "function (combo, date)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.DateField", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Date", + "desc" : "The date selected", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -82631,7 +219117,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -82639,7 +219143,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "applyTo", @@ -82647,7 +219187,31 @@ "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", "sig" : "(el)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] }, { "name" : "autoSize", @@ -82655,7 +219219,18 @@ "desc" : "", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.TriggerField" + "memberOf" : "Roo.form.TriggerField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -82663,7 +219238,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -82671,7 +219276,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -82679,7 +219295,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -82687,7 +219314,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -82695,7 +219339,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -82703,7 +219364,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -82711,7 +219402,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getBox", @@ -82719,7 +219434,25 @@ "desc" : "Gets the current box measurements of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -82727,7 +219460,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -82735,7 +219485,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -82743,7 +219510,24 @@ "desc" : "Returns the name attribute of the field if available", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] }, { "name" : "getPosition", @@ -82751,7 +219535,31 @@ "desc" : "Gets the current XY position of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] }, { "name" : "getRawValue", @@ -82759,7 +219567,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getSize", @@ -82767,7 +219592,24 @@ "desc" : "Gets the current size of the component's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] }, { "name" : "getValue", @@ -82775,7 +219617,24 @@ "desc" : "Returns the current date value of the date field.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Date", + "desc" : "The date value" + } + ] }, { "name" : "hasChanged", @@ -82783,7 +219642,18 @@ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -82791,7 +219661,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -82799,7 +219693,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isDirty", @@ -82807,7 +219718,18 @@ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValid", @@ -82815,7 +219737,31 @@ "desc" : "Returns whether or not the field value is currently valid", "sig" : "(preventMark)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "isVisible", @@ -82823,7 +219769,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -82831,7 +219788,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -82839,7 +219814,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onPosition", @@ -82847,7 +219858,31 @@ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onResize", @@ -82855,7 +219890,43 @@ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onTriggerClick", @@ -82863,7 +219934,25 @@ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.form.TriggerField" + "memberOf" : "Roo.form.TriggerField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -82871,7 +219960,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -82879,7 +219979,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -82887,7 +220005,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -82895,7 +220043,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -82903,7 +220069,18 @@ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "resetHasChanged", @@ -82911,7 +220088,18 @@ "desc" : "stores the current value in loadedValue", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "selectText", @@ -82919,7 +220107,31 @@ "desc" : "Selects text in this field", "sig" : "(start, end)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDisabled", @@ -82927,7 +220139,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setPagePosition", @@ -82935,7 +220165,31 @@ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPosition", @@ -82943,7 +220197,31 @@ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", "sig" : "(left, top)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRawValue", @@ -82951,7 +220229,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setSize", @@ -82959,7 +220255,37 @@ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] }, { "name" : "setValue", @@ -82967,7 +220293,25 @@ "desc" : "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using DateField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n
Usage:\n
\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\ndateField.setValue(dt);\n\n//Pass a date string (default format):\ndateField.setValue('5/4/06');\n\n//Pass a date string (custom format):\ndateField.format = 'Y-m-d';\ndateField.setValue('2006-5-4');\n
", "sig" : "(date)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "date", + "type" : "String/Date", + "desc" : "The date or valid date string", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -82975,7 +220319,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -82983,7 +220351,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "syncSize", @@ -82991,7 +220376,18 @@ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -82999,7 +220395,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateBox", @@ -83007,7 +220433,25 @@ "desc" : "Sets the current box measurements of the component's underlying element.", "sig" : "(box)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "validate", @@ -83015,7 +220459,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -83023,7 +220484,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -83093,11 +220578,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "inputType", @@ -83196,133 +220677,446 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires after the component is moved.", "sig" : "function (_self, x, y)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires after the component is resized.", "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -83332,7 +221126,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -83340,7 +221152,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "applyTo", @@ -83348,7 +221196,31 @@ "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", "sig" : "(el)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] }, { "name" : "capture", @@ -83356,7 +221228,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -83364,7 +221266,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -83372,7 +221285,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -83380,7 +221304,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -83388,7 +221329,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -83396,7 +221354,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -83404,7 +221392,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getBox", @@ -83412,7 +221424,25 @@ "desc" : "Gets the current box measurements of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -83420,7 +221450,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -83428,7 +221475,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -83436,7 +221500,24 @@ "desc" : "Returns the name attribute of the field if available", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] }, { "name" : "getPosition", @@ -83444,7 +221525,31 @@ "desc" : "Gets the current XY position of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] }, { "name" : "getRawValue", @@ -83452,7 +221557,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getSize", @@ -83460,7 +221582,24 @@ "desc" : "Gets the current size of the component's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] }, { "name" : "getValue", @@ -83468,7 +221607,24 @@ "desc" : "Returns the checked state of the checkbox.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if checked, else false" + } + ] }, { "name" : "hasChanged", @@ -83476,7 +221632,18 @@ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -83484,7 +221651,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -83492,7 +221683,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isDirty", @@ -83500,7 +221708,18 @@ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValid", @@ -83508,7 +221727,31 @@ "desc" : "Returns whether or not the field value is currently valid", "sig" : "(preventMark)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "isVisible", @@ -83516,7 +221759,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -83524,7 +221778,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -83532,7 +221804,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onPosition", @@ -83540,7 +221848,31 @@ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onResize", @@ -83548,7 +221880,43 @@ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -83556,7 +221924,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -83564,7 +221943,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -83572,7 +221969,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -83580,7 +222007,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -83588,7 +222033,18 @@ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "resetHasChanged", @@ -83596,7 +222052,18 @@ "desc" : "stores the current value in loadedValue", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setDisabled", @@ -83604,7 +222071,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setPagePosition", @@ -83612,7 +222097,31 @@ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPosition", @@ -83620,7 +222129,31 @@ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", "sig" : "(left, top)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRawValue", @@ -83628,7 +222161,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setSize", @@ -83636,7 +222187,37 @@ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] }, { "name" : "setValue", @@ -83644,7 +222225,31 @@ "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.", "sig" : "(value, suppressEvent)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Boolean/String", + "desc" : "- the value to set", + "isOptional" : false + }, + { + "name" : "suppressEvent", + "type" : "Boolean/String", + "desc" : "- whether to suppress the checkchange event.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -83652,7 +222257,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -83660,7 +222289,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "syncSize", @@ -83668,7 +222314,18 @@ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -83676,7 +222333,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateBox", @@ -83684,7 +222371,25 @@ "desc" : "Sets the current box measurements of the component's underlying element.", "sig" : "(box)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "validate", @@ -83692,7 +222397,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -83720,11 +222442,7 @@ "name" : "closable", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "cls", @@ -83772,11 +222490,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "inputType", @@ -83881,140 +222595,466 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "close", "type" : "function", "desc" : "Fires after the click the close btn", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.DisplayField", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires after the component is moved.", "sig" : "function (_self, x, y)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires after the component is resized.", "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -84024,7 +223064,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -84032,7 +223090,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "applyTo", @@ -84040,7 +223134,31 @@ "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", "sig" : "(el)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] }, { "name" : "capture", @@ -84048,7 +223166,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -84056,7 +223204,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -84064,7 +223223,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -84072,7 +223242,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -84080,7 +223267,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -84088,7 +223292,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -84096,7 +223330,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getBox", @@ -84104,7 +223362,25 @@ "desc" : "Gets the current box measurements of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -84112,7 +223388,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -84120,7 +223413,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -84128,7 +223438,24 @@ "desc" : "Returns the name attribute of the field if available", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] }, { "name" : "getPosition", @@ -84136,7 +223463,31 @@ "desc" : "Gets the current XY position of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] }, { "name" : "getRawValue", @@ -84144,7 +223495,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getSize", @@ -84152,7 +223520,24 @@ "desc" : "Gets the current size of the component's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] }, { "name" : "getValue", @@ -84160,7 +223545,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "hasChanged", @@ -84168,7 +223570,18 @@ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -84176,7 +223589,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -84184,7 +223621,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isDirty", @@ -84192,7 +223646,18 @@ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValid", @@ -84200,7 +223665,31 @@ "desc" : "Returns whether or not the field value is currently valid", "sig" : "(preventMark)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "isVisible", @@ -84208,7 +223697,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -84216,7 +223716,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -84224,7 +223742,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onPosition", @@ -84232,7 +223786,31 @@ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onResize", @@ -84240,7 +223818,43 @@ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -84248,7 +223862,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -84256,7 +223881,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -84264,7 +223907,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -84272,7 +223945,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -84280,7 +223971,18 @@ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "resetHasChanged", @@ -84288,7 +223990,18 @@ "desc" : "stores the current value in loadedValue", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setDisabled", @@ -84296,7 +224009,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setPagePosition", @@ -84304,7 +224035,31 @@ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPosition", @@ -84312,7 +224067,31 @@ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", "sig" : "(left, top)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRawValue", @@ -84320,7 +224099,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setSize", @@ -84328,7 +224125,37 @@ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] }, { "name" : "setValue", @@ -84336,7 +224163,25 @@ "desc" : "Sets the checked state of the checkbox.", "sig" : "(checked)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "checked", + "type" : "Boolean/String", + "desc" : "True, 'true', '1', or 'on' to check the checkbox, any other value will uncheck it.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -84344,7 +224189,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -84352,7 +224221,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "syncSize", @@ -84360,7 +224246,18 @@ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -84368,7 +224265,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateBox", @@ -84376,7 +224303,25 @@ "desc" : "Sets the current box measurements of the component's underlying element.", "sig" : "(box)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "validate", @@ -84384,7 +224329,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -84508,11 +224470,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "inputType", @@ -84677,147 +224635,498 @@ "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", "sig" : "function (_self, width)\n{\n\n}", - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "editorinit", "type" : "function", "desc" : "Fired when the editor is initialized - you can add extra handlers here..", "sig" : "function (_self, the)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "FCKeditor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "the", + "type" : "Object", + "desc" : "FCK object.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enable", "type" : "function", "desc" : "Fires after the component is enabled.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires after the component is moved.", "sig" : "function (_self, x, y)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires after the component is resized.", "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -84827,7 +225136,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -84835,7 +225162,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "applyTo", @@ -84843,7 +225206,31 @@ "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", "sig" : "(el)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] }, { "name" : "autoSize", @@ -84851,7 +225238,18 @@ "desc" : "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.TextArea" + "memberOf" : "Roo.form.TextArea", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -84859,7 +225257,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -84867,7 +225295,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -84875,7 +225314,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -84883,7 +225333,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -84891,7 +225358,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -84899,7 +225383,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -84907,7 +225421,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getBox", @@ -84915,7 +225453,25 @@ "desc" : "Gets the current box measurements of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -84923,7 +225479,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -84931,7 +225504,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -84939,7 +225529,24 @@ "desc" : "Returns the name attribute of the field if available", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] }, { "name" : "getPosition", @@ -84947,7 +225554,31 @@ "desc" : "Gets the current XY position of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] }, { "name" : "getRawValue", @@ -84955,7 +225586,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getSize", @@ -84963,7 +225611,24 @@ "desc" : "Gets the current size of the component's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] }, { "name" : "getValue", @@ -84971,7 +225636,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "hasChanged", @@ -84979,7 +225661,18 @@ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -84987,7 +225680,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -84995,7 +225712,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isDirty", @@ -85003,7 +225737,18 @@ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValid", @@ -85011,7 +225756,31 @@ "desc" : "Returns whether or not the field value is currently valid", "sig" : "(preventMark)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "isVisible", @@ -85019,7 +225788,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -85027,7 +225807,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -85035,7 +225833,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onPosition", @@ -85043,7 +225877,31 @@ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onResize", @@ -85051,7 +225909,43 @@ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -85059,7 +225953,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -85067,7 +225972,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -85075,7 +225998,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -85083,7 +226036,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -85091,7 +226062,18 @@ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "resetHasChanged", @@ -85099,7 +226081,18 @@ "desc" : "stores the current value in loadedValue", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "selectText", @@ -85107,7 +226100,31 @@ "desc" : "Selects text in this field", "sig" : "(start, end)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDisabled", @@ -85115,7 +226132,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setPagePosition", @@ -85123,7 +226158,31 @@ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPosition", @@ -85131,7 +226190,31 @@ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", "sig" : "(left, top)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRawValue", @@ -85139,7 +226222,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setSize", @@ -85147,7 +226248,37 @@ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] }, { "name" : "setValue", @@ -85155,7 +226286,25 @@ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -85163,7 +226312,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -85171,7 +226344,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "syncSize", @@ -85179,7 +226369,18 @@ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -85187,7 +226388,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateBox", @@ -85195,7 +226426,25 @@ "desc" : "Sets the current box measurements of the component's underlying element.", "sig" : "(box)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "validate", @@ -85203,7 +226452,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -85211,7 +226477,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -85281,11 +226571,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "inputType", @@ -85384,133 +226670,446 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires after the component is moved.", "sig" : "function (_self, x, y)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires after the component is resized.", "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -85520,7 +227119,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -85528,7 +227145,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "applyTo", @@ -85536,7 +227189,31 @@ "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", "sig" : "(el)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] }, { "name" : "capture", @@ -85544,7 +227221,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -85552,7 +227259,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -85560,7 +227278,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -85568,7 +227297,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -85576,7 +227322,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -85584,7 +227347,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -85592,7 +227385,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getBox", @@ -85600,7 +227417,25 @@ "desc" : "Gets the current box measurements of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -85608,7 +227443,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -85616,7 +227468,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -85624,7 +227493,24 @@ "desc" : "Returns the name attribute of the field if available", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] }, { "name" : "getPosition", @@ -85632,7 +227518,31 @@ "desc" : "Gets the current XY position of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] }, { "name" : "getRawValue", @@ -85640,7 +227550,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getSize", @@ -85648,7 +227575,24 @@ "desc" : "Gets the current size of the component's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] }, { "name" : "getValue", @@ -85656,7 +227600,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "hasChanged", @@ -85664,7 +227625,18 @@ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -85672,7 +227644,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -85680,7 +227676,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isDirty", @@ -85688,7 +227701,18 @@ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValid", @@ -85696,7 +227720,31 @@ "desc" : "Returns whether or not the field value is currently valid", "sig" : "(preventMark)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "isVisible", @@ -85704,7 +227752,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -85712,7 +227771,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -85720,7 +227797,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onPosition", @@ -85728,7 +227841,31 @@ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onResize", @@ -85736,7 +227873,43 @@ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -85744,7 +227917,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -85752,7 +227936,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -85760,7 +227962,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -85768,7 +228000,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -85776,7 +228026,18 @@ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "resetHasChanged", @@ -85784,7 +228045,18 @@ "desc" : "stores the current value in loadedValue", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setDisabled", @@ -85792,7 +228064,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setPagePosition", @@ -85800,7 +228090,31 @@ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPosition", @@ -85808,7 +228122,31 @@ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", "sig" : "(left, top)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRawValue", @@ -85816,7 +228154,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setSize", @@ -85824,7 +228180,37 @@ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] }, { "name" : "setValue", @@ -85832,7 +228218,25 @@ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -85840,7 +228244,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -85848,7 +228276,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "syncSize", @@ -85856,7 +228301,18 @@ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -85864,7 +228320,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateBox", @@ -85872,7 +228358,25 @@ "desc" : "Sets the current box measurements of the component's underlying element.", "sig" : "(box)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "validate", @@ -85880,7 +228384,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -85926,11 +228447,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "labelAlign", @@ -85975,70 +228492,200 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -86048,7 +228695,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -86056,7 +228721,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "addxtype", @@ -86064,7 +228765,25 @@ "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column", "sig" : "(config)", "static" : false, - "memberOf" : "Roo.form.Layout" + "memberOf" : "Roo.form.Layout", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "capture", @@ -86072,7 +228791,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -86080,7 +228829,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -86088,7 +228848,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -86096,7 +228873,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -86104,7 +228898,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -86112,7 +228936,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getEl", @@ -86120,7 +228968,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -86128,7 +228993,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -86136,7 +229018,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -86144,7 +229050,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isVisible", @@ -86152,7 +229075,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -86160,7 +229094,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -86168,7 +229138,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -86176,7 +229157,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -86184,7 +229183,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -86192,7 +229221,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -86200,7 +229247,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisible", @@ -86208,7 +229273,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -86216,7 +229305,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "un", @@ -86224,7 +229330,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -86242,15 +229378,17 @@ "desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"center\")", "memberOf" : "" }, + { + "name" : "buttons[]", + "type" : "Roo.Button", + "desc" : "buttons at bottom of form", + "memberOf" : "" + }, { "name" : "errorMask", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.form.BasicForm", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.form.BasicForm" }, { "name" : "errorReader", @@ -86361,35 +229499,124 @@ "type" : "function", "desc" : "Fires when an action is completed.", "sig" : "function (_self, action)\n{\n\n}", - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Form", + "desc" : "", + "isOptional" : false + }, + { + "name" : "action", + "type" : "Action", + "desc" : "The action that completed", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "actionfailed", "type" : "function", "desc" : "Fires when an action fails.", "sig" : "function (_self, action)\n{\n\n}", - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Form", + "desc" : "", + "isOptional" : false + }, + { + "name" : "action", + "type" : "Action", + "desc" : "The action that failed", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeaction", "type" : "function", "desc" : "Fires before any action is performed. Return false to cancel the action.", "sig" : "function (_self, action)\n{\n\n}", - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Form", + "desc" : "", + "isOptional" : false + }, + { + "name" : "action", + "type" : "Action", + "desc" : "The action to be performed", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "clientvalidation", "type" : "function", "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state", "sig" : "function (_self, valid)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Form", + "desc" : "", + "isOptional" : false + }, + { + "name" : "valid", + "type" : "Boolean", + "desc" : "true if the form has passed client-side validation", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rendered", "type" : "function", "desc" : "Fires when the form is rendered", "sig" : "function (form)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "form", + "type" : "Roo.form.Form", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -86399,7 +229626,37 @@ "desc" : "Add Roo.form components to the current open container (e.g. column, fieldset, etc.). Fields added via this method\ncan also be passed with an additional property of fieldLabel, which if supplied, will provide the text to display\nas the label of the field.", "sig" : "(field1, field2)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "field1", + "type" : "Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "field2", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Form", + "desc" : "this" + } + ] }, { "name" : "addButton", @@ -86407,7 +229664,43 @@ "desc" : "Adds a button to the footer of the form - this must be called before the form is rendered.", "sig" : "(config, handler, scope)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "config", + "type" : "String/Object", + "desc" : "A string becomes the button text, an object can either be a Button config\nobject or a valid Roo.DomHelper element config", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The function called when the button is clicked", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the handler function", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.Button", + "desc" : "" + } + ] }, { "name" : "addEvents", @@ -86415,7 +229708,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addForm", @@ -86423,7 +229734,25 @@ "desc" : "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms.", "sig" : "(form)", "static" : false, - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "form", + "type" : "Roo.form.Form", + "desc" : "to add.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addListener", @@ -86431,7 +229760,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "addxtype", @@ -86439,7 +229804,25 @@ "desc" : "Adds a series of form elements (using the xtype property as the factory method.\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column, (and 'end' to close a block)", "sig" : "(config)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "applyIfToFields", @@ -86447,7 +229830,31 @@ "desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.", "sig" : "(values)", "static" : false, - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "values", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "applyToFields", @@ -86455,7 +229862,31 @@ "desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.", "sig" : "(values)", "static" : false, - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "values", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "capture", @@ -86463,7 +229894,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -86471,7 +229932,24 @@ "desc" : "Clears all invalid messages in this form.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "column", @@ -86479,7 +229957,49 @@ "desc" : "Opens a new {@link Roo.form.Column} container in the layout stack. If fields are passed after the config, the\nfields are added and the column is closed. If no fields are passed the column remains open\nuntil end() is called.", "sig" : "(config, field1, field2, etc)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "The config to pass to the column", + "isOptional" : false + }, + { + "name" : "field1", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + }, + { + "name" : "field2", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + }, + { + "name" : "etc", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Column The column container object" + } + ] }, { "name" : "container", @@ -86487,7 +230007,49 @@ "desc" : "Opens a new {@link Roo.form.Layout} container in the layout stack. If fields are passed after the config, the\nfields are added and the container is closed. If no fields are passed the container remains open\nuntil end() is called.", "sig" : "(config, field1, field2, etc)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "The config to pass to the Layout", + "isOptional" : false + }, + { + "name" : "field1", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + }, + { + "name" : "field2", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + }, + { + "name" : "etc", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Layout The container object" + } + ] }, { "name" : "doAction", @@ -86495,7 +230057,37 @@ "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.", "sig" : "(actionName, options)", "static" : false, - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "actionName", + "type" : "String", + "desc" : "The name of the action type", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) The options to pass to the action. All of the config options listed\nbelow are supported by both the submit and load actions unless otherwise noted (custom actions could also\naccept other config options):\n
\nProperty          Type             Description\n----------------  ---------------  ----------------------------------------------------------------------------------\nurl               String           The url for the action (defaults to the form's url)\nmethod            String           The form method to use (defaults to the form's method, or POST if not defined)\nparams            String/Object    The params to pass (defaults to the form's baseParams, or none if not defined)\nclientValidation  Boolean          Applies to submit only.  Pass true to call form.isValid() prior to posting to\n                                   validate the form on the client (defaults to false)\n
", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "end", @@ -86503,7 +230095,24 @@ "desc" : "Closes the current open container", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Form", + "desc" : "this" + } + ] }, { "name" : "fieldset", @@ -86511,7 +230120,49 @@ "desc" : "Opens a new {@link Roo.form.FieldSet} container in the layout stack. If fields are passed after the config, the\nfields are added and the fieldset is closed. If no fields are passed the fieldset remains open\nuntil end() is called.", "sig" : "(config, field1, field2, etc)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "The config to pass to the fieldset", + "isOptional" : false + }, + { + "name" : "field1", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + }, + { + "name" : "field2", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + }, + { + "name" : "etc", + "type" : "Field", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "FieldSet The fieldset container object" + } + ] }, { "name" : "findField", @@ -86519,7 +230170,31 @@ "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The value to search for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Field" + } + ] }, { "name" : "findbyId", @@ -86527,7 +230202,31 @@ "desc" : "Find any element that has been added to a form, using it's ID or name\nThis can include framesets, columns etc. along with regular fields..", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "- id or name to find.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "e - or false if nothing found." + } + ] }, { "name" : "fireEvent", @@ -86535,7 +230234,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getFieldValues", @@ -86543,7 +230272,24 @@ "desc" : "Returns the fields in this form as an object with key/value pairs. \nThis differs from getValues as it calls getValue on each child item, rather than using dom data.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "" + } + ] }, { "name" : "getValues", @@ -86551,7 +230297,31 @@ "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.", "sig" : "(asString)", "static" : false, - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "asString", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "" + } + ] }, { "name" : "hasChanged", @@ -86559,7 +230329,24 @@ "desc" : "Returns true if any fields in this form have changed since their original load. (New version)", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] }, { "name" : "hasListener", @@ -86567,7 +230354,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "invalidFields", @@ -86575,7 +230386,24 @@ "desc" : "Returns array of invalid form fields.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Array" + } + ] }, { "name" : "isDirty", @@ -86583,7 +230411,24 @@ "desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] }, { "name" : "isValid", @@ -86591,7 +230436,24 @@ "desc" : "Returns true if client-side validation on the form is successful.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] }, { "name" : "load", @@ -86599,7 +230461,31 @@ "desc" : "Shortcut to do a load action.", "sig" : "(options)", "static" : false, - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "The options to pass to the action (see {@link #doAction} for details)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "loadRecord", @@ -86607,7 +230493,31 @@ "desc" : "Loads an Roo.data.Record into this form.", "sig" : "(record)", "static" : false, - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "record", + "type" : "Record", + "desc" : "The record to load", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "markInvalid", @@ -86615,7 +230525,31 @@ "desc" : "Mark fields in this form invalid in bulk.", "sig" : "(errors)", "static" : false, - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "errors", + "type" : "Array/Object", + "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "on", @@ -86623,7 +230557,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -86631,7 +230601,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -86639,7 +230620,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "remove", @@ -86647,7 +230646,31 @@ "desc" : "Removes a field from the items collection (does NOT remove its markup).", "sig" : "(field)", "static" : false, - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "field", + "type" : "Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "removeListener", @@ -86655,7 +230678,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -86663,7 +230716,31 @@ "desc" : "Render this form into the passed container. This should only be called once!", "sig" : "(container)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "container", + "type" : "String/HTMLElement/Element", + "desc" : "The element this component should be rendered into", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Form", + "desc" : "this" + } + ] }, { "name" : "reset", @@ -86671,7 +230748,24 @@ "desc" : "Resets this form.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "resetHasChanged", @@ -86679,7 +230773,24 @@ "desc" : "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Boolean" + } + ] }, { "name" : "setValues", @@ -86687,7 +230798,31 @@ "desc" : "Set values for fields in this form in bulk.", "sig" : "(values)", "static" : false, - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "values", + "type" : "Array/Object", + "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "start", @@ -86695,7 +230830,31 @@ "desc" : "Opens the passed container in the layout stack. The container can be any {@link Roo.form.Layout} or subclass.", "sig" : "(container)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "container", + "type" : "Object", + "desc" : "A Roo.form.Layout or subclass of Layout", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Form", + "desc" : "this" + } + ] }, { "name" : "startMonitoring", @@ -86703,7 +230862,18 @@ "desc" : "Starts monitoring of the valid state of this form. Usually this is done by passing the config\noption \"monitorValid\"", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "stopMonitoring", @@ -86711,7 +230881,18 @@ "desc" : "Stops monitoring of the valid state of this form", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "submit", @@ -86719,7 +230900,31 @@ "desc" : "Shortcut to do a submit action.", "sig" : "(options)", "static" : false, - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "options", + "type" : "Object", + "desc" : "The options to pass to the action (see {@link #doAction} for details)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] }, { "name" : "un", @@ -86727,7 +230932,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateRecord", @@ -86735,7 +230970,31 @@ "desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.", "sig" : "(record)", "static" : false, - "memberOf" : "Roo.form.BasicForm" + "memberOf" : "Roo.form.BasicForm", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "record", + "type" : "Record", + "desc" : "The record to edit", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "BasicForm", + "desc" : "this" + } + ] } ] }, @@ -86811,11 +231070,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "inputType", @@ -86920,133 +231175,446 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires after the component is moved.", "sig" : "function (_self, x, y)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires after the component is resized.", "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -87056,7 +231624,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -87064,7 +231650,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "applyTo", @@ -87072,7 +231694,31 @@ "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", "sig" : "(el)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] }, { "name" : "capture", @@ -87080,7 +231726,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -87088,7 +231764,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -87096,7 +231783,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -87104,7 +231802,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -87112,7 +231827,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -87120,7 +231852,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -87128,7 +231890,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getBox", @@ -87136,7 +231922,25 @@ "desc" : "Gets the current box measurements of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -87144,7 +231948,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -87152,7 +231973,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -87160,7 +231998,24 @@ "desc" : "Returns the name attribute of the field if available", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] }, { "name" : "getPosition", @@ -87168,7 +232023,31 @@ "desc" : "Gets the current XY position of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] }, { "name" : "getRawValue", @@ -87176,7 +232055,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getSize", @@ -87184,7 +232080,24 @@ "desc" : "Gets the current size of the component's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] }, { "name" : "getValue", @@ -87192,7 +232105,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "hasChanged", @@ -87200,7 +232130,18 @@ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -87208,7 +232149,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -87216,7 +232181,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isDirty", @@ -87224,7 +232206,18 @@ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValid", @@ -87232,7 +232225,31 @@ "desc" : "Returns whether or not the field value is currently valid", "sig" : "(preventMark)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "isVisible", @@ -87240,7 +232257,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -87248,7 +232276,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -87256,7 +232302,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onPosition", @@ -87264,7 +232346,31 @@ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onResize", @@ -87272,7 +232378,43 @@ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -87280,7 +232422,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -87288,7 +232441,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -87296,7 +232467,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -87304,7 +232505,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -87312,7 +232531,18 @@ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "resetHasChanged", @@ -87320,7 +232550,18 @@ "desc" : "stores the current value in loadedValue", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setDisabled", @@ -87328,7 +232569,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setPagePosition", @@ -87336,7 +232595,31 @@ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPosition", @@ -87344,7 +232627,31 @@ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", "sig" : "(left, top)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRawValue", @@ -87352,7 +232659,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setSize", @@ -87360,7 +232685,37 @@ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] }, { "name" : "setValue", @@ -87368,7 +232723,25 @@ "desc" : "Sets the value of the item.", "sig" : "(either)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "either", + "type" : "String", + "desc" : "an object or a string..", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -87376,7 +232749,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -87384,7 +232781,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "syncSize", @@ -87392,7 +232806,18 @@ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -87400,7 +232825,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateBox", @@ -87408,7 +232863,25 @@ "desc" : "Sets the current box measurements of the component's underlying element.", "sig" : "(box)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "validate", @@ -87416,7 +232889,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -87534,11 +233024,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "inputType", @@ -87697,140 +233183,472 @@ "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", "sig" : "function (_self, width)\n{\n\n}", - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires after the component is moved.", "sig" : "function (_self, x, y)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires after the component is resized.", "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -87840,7 +233658,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -87848,7 +233684,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "applyTo", @@ -87856,7 +233728,31 @@ "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", "sig" : "(el)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] }, { "name" : "autoSize", @@ -87864,7 +233760,18 @@ "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -87872,7 +233779,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -87880,7 +233817,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -87888,7 +233836,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -87896,7 +233855,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -87904,7 +233880,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -87912,7 +233905,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -87920,7 +233943,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getBox", @@ -87928,7 +233975,25 @@ "desc" : "Gets the current box measurements of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -87936,7 +234001,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -87944,7 +234026,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -87952,7 +234051,24 @@ "desc" : "Returns the name attribute of the field if available", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] }, { "name" : "getPosition", @@ -87960,7 +234076,31 @@ "desc" : "Gets the current XY position of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] }, { "name" : "getRawValue", @@ -87968,7 +234108,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getSize", @@ -87976,7 +234133,24 @@ "desc" : "Gets the current size of the component's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] }, { "name" : "getValue", @@ -87984,7 +234158,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "hasChanged", @@ -87992,7 +234183,18 @@ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -88000,7 +234202,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -88008,7 +234234,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isDirty", @@ -88016,7 +234259,18 @@ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValid", @@ -88024,7 +234278,31 @@ "desc" : "Returns whether or not the field value is currently valid", "sig" : "(preventMark)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "isVisible", @@ -88032,7 +234310,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -88040,7 +234329,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -88048,7 +234355,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onPosition", @@ -88056,7 +234399,31 @@ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onResize", @@ -88064,7 +234431,43 @@ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -88072,7 +234475,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -88080,7 +234494,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -88088,7 +234520,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -88096,7 +234558,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -88104,7 +234584,18 @@ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "resetHasChanged", @@ -88112,7 +234603,18 @@ "desc" : "stores the current value in loadedValue", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "selectText", @@ -88120,7 +234622,31 @@ "desc" : "Selects text in this field", "sig" : "(start, end)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDisabled", @@ -88128,7 +234654,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setPagePosition", @@ -88136,7 +234680,31 @@ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPosition", @@ -88144,7 +234712,31 @@ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", "sig" : "(left, top)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRawValue", @@ -88152,7 +234744,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setSize", @@ -88160,7 +234770,37 @@ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] }, { "name" : "setValue", @@ -88168,7 +234808,25 @@ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -88176,7 +234834,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -88184,7 +234866,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "syncSize", @@ -88192,7 +234891,18 @@ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -88200,7 +234910,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateBox", @@ -88208,7 +234948,25 @@ "desc" : "Sets the current box measurements of the component's underlying element.", "sig" : "(box)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "validate", @@ -88216,7 +234974,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -88224,7 +234999,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -88294,11 +235093,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "listeners", @@ -88391,217 +235186,670 @@ "type" : "function", "desc" : "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "autosave", "type" : "function", "desc" : "Auto save the htmlEditor value as a file into Events", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforepush", "type" : "function", "desc" : "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push.", "sig" : "function (_self, html)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "html", + "type" : "String", + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforesync", "type" : "function", "desc" : "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync.", "sig" : "function (_self, html)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "", "sig" : "function ()\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "", "sig" : "function ()\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "editmodechange", "type" : "function", "desc" : "Fires when the editor switches edit modes", "sig" : "function (_self, sourceEdit)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "sourceEdit", + "type" : "Boolean", + "desc" : "True if source edit, false if standard editing.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "editorevent", "type" : "function", "desc" : "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enable", "type" : "function", "desc" : "Fires after the component is enabled.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "firstfocus", "type" : "function", "desc" : "Fires when on first focus - needed by toolbars..", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "", "sig" : "function ()\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "initialize", "type" : "function", "desc" : "Fires when the editor is fully initialized (including the iframe)", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires after the component is moved.", "sig" : "function (_self, x, y)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "push", "type" : "function", "desc" : "Fires when the iframe editor is updated with content from the textarea.", "sig" : "function (_self, html)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires after the component is resized.", "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "savedpreview", "type" : "function", "desc" : "preview the saved version of htmlEditor", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "", "sig" : "function ()\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [], + "returns" : [] }, { "name" : "stylesheetsclick", "type" : "function", "desc" : "Fires when press the Sytlesheets button", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.HtmlEditorCore", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "sync", "type" : "function", "desc" : "Fires when the textarea is updated with content from the editor iframe.", "sig" : "function (_self, html)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "html", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -88611,7 +235859,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -88619,7 +235885,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "applyTo", @@ -88627,7 +235929,31 @@ "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", "sig" : "(el)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] }, { "name" : "capture", @@ -88635,7 +235961,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -88643,7 +235999,18 @@ "desc" : "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "createToolbar", @@ -88651,7 +236018,25 @@ "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.", "sig" : "(editor)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "editor", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", @@ -88659,7 +236044,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -88667,7 +236063,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -88675,7 +236088,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -88683,7 +236113,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -88691,7 +236151,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getBox", @@ -88699,7 +236183,25 @@ "desc" : "Gets the current box measurements of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -88707,7 +236209,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -88715,7 +236234,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -88723,7 +236259,24 @@ "desc" : "Returns the name attribute of the field if available", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] }, { "name" : "getPosition", @@ -88731,7 +236284,31 @@ "desc" : "Gets the current XY position of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] }, { "name" : "getRawValue", @@ -88739,7 +236316,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getSize", @@ -88747,7 +236341,24 @@ "desc" : "Gets the current size of the component's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] }, { "name" : "getValue", @@ -88755,7 +236366,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "hasChanged", @@ -88763,7 +236391,18 @@ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -88771,7 +236410,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -88779,7 +236442,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isDirty", @@ -88787,7 +236467,18 @@ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValid", @@ -88795,7 +236486,31 @@ "desc" : "Returns whether or not the field value is currently valid", "sig" : "(preventMark)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "isVisible", @@ -88803,7 +236518,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -88811,7 +236537,18 @@ "desc" : "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -88819,7 +236556,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onPosition", @@ -88827,7 +236600,31 @@ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onResize", @@ -88835,7 +236632,43 @@ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -88843,7 +236676,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -88851,7 +236695,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -88859,7 +236721,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -88867,7 +236759,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -88875,7 +236785,18 @@ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "resetHasChanged", @@ -88883,7 +236804,18 @@ "desc" : "stores the current value in loadedValue", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setDisabled", @@ -88891,7 +236823,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setPagePosition", @@ -88899,7 +236849,31 @@ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPosition", @@ -88907,7 +236881,31 @@ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", "sig" : "(left, top)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRawValue", @@ -88915,7 +236913,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setSize", @@ -88923,7 +236939,37 @@ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] }, { "name" : "setValue", @@ -88931,7 +236977,25 @@ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -88939,7 +237003,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -88947,7 +237035,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "syncSize", @@ -88955,7 +237060,18 @@ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "toggleSourceEdit", @@ -88963,7 +237079,25 @@ "desc" : "Toggles the editor between standard and source edit mode.", "sig" : "(sourceEdit)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "sourceEdit", + "type" : "Boolean", + "desc" : "(optional) True for source edit, false for standard", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "un", @@ -88971,7 +237105,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateBox", @@ -88979,7 +237143,25 @@ "desc" : "Sets the current box measurements of the component's underlying element.", "sig" : "(box)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "validate", @@ -88987,7 +237169,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -89014,7 +237213,18 @@ "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.\n\nNote you can force an update by calling on('editorevent', scope, false)", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -89065,7 +237275,18 @@ "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -89111,11 +237332,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "labelAlign", @@ -89154,70 +237371,200 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -89227,7 +237574,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -89235,7 +237600,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "addxtype", @@ -89243,7 +237644,25 @@ "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column", "sig" : "(config)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "capture", @@ -89251,7 +237670,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -89259,7 +237708,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -89267,7 +237727,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -89275,7 +237752,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -89283,7 +237777,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -89291,7 +237815,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getEl", @@ -89299,7 +237847,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -89307,7 +237872,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -89315,7 +237897,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -89323,7 +237929,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isVisible", @@ -89331,7 +237954,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -89339,7 +237973,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -89347,7 +238017,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -89355,7 +238036,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -89363,7 +238062,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -89371,7 +238100,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -89379,7 +238126,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisible", @@ -89387,7 +238152,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -89395,7 +238184,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "un", @@ -89403,7 +238209,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -89539,11 +238375,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "hideTrigger", @@ -89744,147 +238576,498 @@ "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", "sig" : "function (_self, width)\n{\n\n}", - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires after the component is moved.", "sig" : "function (_self, x, y)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires after the component is resized.", "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "select", "type" : "function", "desc" : "Fires when a date is selected", "sig" : "function (combo, date)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.MonthFieeld", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Date", + "desc" : "The date selected", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -89894,7 +239077,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -89902,7 +239103,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "applyTo", @@ -89910,7 +239147,31 @@ "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", "sig" : "(el)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] }, { "name" : "autoSize", @@ -89918,7 +239179,18 @@ "desc" : "", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.TriggerField" + "memberOf" : "Roo.form.TriggerField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -89926,7 +239198,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -89934,7 +239236,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -89942,7 +239255,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -89950,7 +239274,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -89958,7 +239299,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -89966,7 +239324,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -89974,7 +239362,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getBox", @@ -89982,7 +239394,25 @@ "desc" : "Gets the current box measurements of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -89990,7 +239420,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -89998,7 +239445,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -90006,7 +239470,24 @@ "desc" : "Returns the name attribute of the field if available", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] }, { "name" : "getPosition", @@ -90014,7 +239495,31 @@ "desc" : "Gets the current XY position of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] }, { "name" : "getRawValue", @@ -90022,7 +239527,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getSize", @@ -90030,7 +239552,24 @@ "desc" : "Gets the current size of the component's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] }, { "name" : "getValue", @@ -90038,7 +239577,24 @@ "desc" : "Returns the current date value of the date field.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Date", + "desc" : "The date value" + } + ] }, { "name" : "hasChanged", @@ -90046,7 +239602,18 @@ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -90054,7 +239621,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -90062,7 +239653,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isDirty", @@ -90070,7 +239678,18 @@ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValid", @@ -90078,7 +239697,31 @@ "desc" : "Returns whether or not the field value is currently valid", "sig" : "(preventMark)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "isVisible", @@ -90086,7 +239729,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -90094,7 +239748,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -90102,7 +239774,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onPosition", @@ -90110,7 +239818,31 @@ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onResize", @@ -90118,7 +239850,43 @@ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onTriggerClick", @@ -90126,7 +239894,25 @@ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.form.TriggerField" + "memberOf" : "Roo.form.TriggerField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -90134,7 +239920,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -90142,7 +239939,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -90150,7 +239965,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -90158,7 +240003,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -90166,7 +240029,18 @@ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "resetHasChanged", @@ -90174,7 +240048,18 @@ "desc" : "stores the current value in loadedValue", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "selectText", @@ -90182,7 +240067,31 @@ "desc" : "Selects text in this field", "sig" : "(start, end)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDisabled", @@ -90190,7 +240099,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setPagePosition", @@ -90198,7 +240125,31 @@ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPosition", @@ -90206,7 +240157,31 @@ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", "sig" : "(left, top)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRawValue", @@ -90214,7 +240189,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setSize", @@ -90222,7 +240215,37 @@ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] }, { "name" : "setValue", @@ -90230,7 +240253,25 @@ "desc" : "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using MonthField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n
Usage:\n
\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\nmonthField.setValue(dt);\n\n//Pass a date string (default format):\nmonthField.setValue('5/4/06');\n\n//Pass a date string (custom format):\nmonthField.format = 'Y-m-d';\nmonthField.setValue('2006-5-4');\n
", "sig" : "(date)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "date", + "type" : "String/Date", + "desc" : "The date or valid date string", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -90238,7 +240279,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -90246,7 +240311,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "syncSize", @@ -90254,7 +240336,18 @@ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -90262,7 +240355,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateBox", @@ -90270,7 +240393,25 @@ "desc" : "Sets the current box measurements of the component's underlying element.", "sig" : "(box)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "validate", @@ -90278,7 +240419,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -90286,7 +240444,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -90428,11 +240610,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "inputType", @@ -90621,140 +240799,472 @@ "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", "sig" : "function (_self, width)\n{\n\n}", - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires after the component is moved.", "sig" : "function (_self, x, y)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires after the component is resized.", "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -90764,7 +241274,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -90772,7 +241300,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "applyTo", @@ -90780,7 +241344,31 @@ "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", "sig" : "(el)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] }, { "name" : "autoSize", @@ -90788,7 +241376,18 @@ "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -90796,7 +241395,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -90804,7 +241433,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -90812,7 +241452,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -90820,7 +241471,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -90828,7 +241496,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -90836,7 +241521,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -90844,7 +241559,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getBox", @@ -90852,7 +241591,25 @@ "desc" : "Gets the current box measurements of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -90860,7 +241617,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -90868,7 +241642,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -90876,7 +241667,24 @@ "desc" : "Returns the name attribute of the field if available", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] }, { "name" : "getPosition", @@ -90884,7 +241692,31 @@ "desc" : "Gets the current XY position of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] }, { "name" : "getRawValue", @@ -90892,7 +241724,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getSize", @@ -90900,7 +241749,24 @@ "desc" : "Gets the current size of the component's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] }, { "name" : "getValue", @@ -90908,7 +241774,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "hasChanged", @@ -90916,7 +241799,18 @@ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -90924,7 +241818,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -90932,7 +241850,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isDirty", @@ -90940,7 +241875,18 @@ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValid", @@ -90948,7 +241894,31 @@ "desc" : "Returns whether or not the field value is currently valid", "sig" : "(preventMark)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "isVisible", @@ -90956,7 +241926,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -90964,7 +241945,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -90972,7 +241971,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onPosition", @@ -90980,7 +242015,31 @@ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onResize", @@ -90988,7 +242047,43 @@ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -90996,7 +242091,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -91004,7 +242110,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -91012,7 +242136,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -91020,7 +242174,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -91028,7 +242200,18 @@ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "resetHasChanged", @@ -91036,7 +242219,18 @@ "desc" : "stores the current value in loadedValue", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "selectText", @@ -91044,7 +242238,31 @@ "desc" : "Selects text in this field", "sig" : "(start, end)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDisabled", @@ -91052,7 +242270,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setPagePosition", @@ -91060,7 +242296,31 @@ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPosition", @@ -91068,7 +242328,31 @@ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", "sig" : "(left, top)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRawValue", @@ -91076,7 +242360,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setSize", @@ -91084,7 +242386,37 @@ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] }, { "name" : "setValue", @@ -91092,7 +242424,25 @@ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -91100,7 +242450,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -91108,7 +242482,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "syncSize", @@ -91116,7 +242507,18 @@ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -91124,7 +242526,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateBox", @@ -91132,7 +242564,25 @@ "desc" : "Sets the current box measurements of the component's underlying element.", "sig" : "(box)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "validate", @@ -91140,7 +242590,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -91148,7 +242615,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -91230,11 +242721,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "inputType", @@ -91345,140 +242832,472 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "check", "type" : "function", "desc" : "Fires when the checkbox is checked or unchecked.", "sig" : "function (_self, checked)\n{\n\n}", - "memberOf" : "Roo.form.Checkbox" + "memberOf" : "Roo.form.Checkbox", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Checkbox", + "desc" : "This checkbox", + "isOptional" : false + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "The new checked value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires after the component is moved.", "sig" : "function (_self, x, y)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires after the component is resized.", "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -91488,7 +243307,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -91496,7 +243333,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "applyTo", @@ -91504,7 +243377,31 @@ "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", "sig" : "(el)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] }, { "name" : "capture", @@ -91512,7 +243409,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -91520,7 +243447,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -91528,7 +243466,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -91536,7 +243485,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -91544,7 +243510,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -91552,7 +243535,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -91560,7 +243573,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getBox", @@ -91568,7 +243605,25 @@ "desc" : "Gets the current box measurements of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -91576,7 +243631,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getGroupValue", @@ -91584,7 +243656,24 @@ "desc" : "If this radio is part of a group, it will return the selected value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getId", @@ -91592,7 +243681,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -91600,7 +243706,24 @@ "desc" : "Returns the name attribute of the field if available", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] }, { "name" : "getPosition", @@ -91608,7 +243731,31 @@ "desc" : "Gets the current XY position of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] }, { "name" : "getRawValue", @@ -91616,7 +243763,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getSize", @@ -91624,7 +243788,24 @@ "desc" : "Gets the current size of the component's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] }, { "name" : "getValue", @@ -91632,7 +243813,24 @@ "desc" : "Returns the checked state of the checkbox.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Checkbox" + "memberOf" : "Roo.form.Checkbox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if checked, else false" + } + ] }, { "name" : "hasChanged", @@ -91640,7 +243838,18 @@ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -91648,7 +243857,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -91656,7 +243889,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isDirty", @@ -91664,7 +243914,18 @@ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValid", @@ -91672,7 +243933,31 @@ "desc" : "Returns whether or not the field value is currently valid", "sig" : "(preventMark)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "isVisible", @@ -91680,7 +243965,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -91688,7 +243984,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -91696,7 +244010,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onPosition", @@ -91704,7 +244054,31 @@ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onResize", @@ -91712,7 +244086,43 @@ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -91720,7 +244130,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -91728,7 +244149,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -91736,7 +244175,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -91744,7 +244213,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -91752,7 +244239,18 @@ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "resetHasChanged", @@ -91760,7 +244258,18 @@ "desc" : "stores the current value in loadedValue", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setDisabled", @@ -91768,7 +244277,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setPagePosition", @@ -91776,7 +244303,31 @@ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPosition", @@ -91784,7 +244335,31 @@ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", "sig" : "(left, top)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRawValue", @@ -91792,7 +244367,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setSize", @@ -91800,7 +244393,37 @@ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] }, { "name" : "setValue", @@ -91808,7 +244431,31 @@ "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.", "sig" : "(value, suppressEvent)", "static" : false, - "memberOf" : "Roo.form.Checkbox" + "memberOf" : "Roo.form.Checkbox", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Boolean/String", + "desc" : "- the value to set", + "isOptional" : false + }, + { + "name" : "suppressEvent", + "type" : "Boolean/String", + "desc" : "- whether to suppress the checkchange event.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -91816,7 +244463,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -91824,7 +244495,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "syncSize", @@ -91832,7 +244520,18 @@ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -91840,7 +244539,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateBox", @@ -91848,7 +244577,25 @@ "desc" : "Sets the current box measurements of the component's underlying element.", "sig" : "(box)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "validate", @@ -91856,7 +244603,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -91908,11 +244672,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "labelAlign", @@ -91957,70 +244717,200 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -92030,7 +244920,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -92038,7 +244946,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "addxtype", @@ -92046,7 +244990,25 @@ "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column", "sig" : "(config)", "static" : false, - "memberOf" : "Roo.form.Layout" + "memberOf" : "Roo.form.Layout", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "capture", @@ -92054,7 +245016,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -92062,7 +245054,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -92070,7 +245073,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -92078,7 +245098,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -92086,7 +245123,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -92094,7 +245161,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getEl", @@ -92102,7 +245193,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -92110,7 +245218,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -92118,7 +245243,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -92126,7 +245275,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isVisible", @@ -92134,7 +245300,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -92142,7 +245319,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -92150,7 +245363,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -92158,7 +245382,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -92166,7 +245408,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -92174,7 +245446,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -92182,7 +245472,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisible", @@ -92190,7 +245498,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -92198,7 +245530,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "un", @@ -92206,7 +245555,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -92384,11 +245763,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "hideTrigger", @@ -92703,140 +246078,472 @@ "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", "sig" : "function (_self, width)\n{\n\n}", - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires after the component is moved.", "sig" : "function (_self, x, y)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires after the component is resized.", "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -92846,7 +246553,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -92854,7 +246579,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "applyTo", @@ -92862,7 +246623,31 @@ "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", "sig" : "(el)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] }, { "name" : "autoSize", @@ -92870,7 +246655,18 @@ "desc" : "", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.TriggerField" + "memberOf" : "Roo.form.TriggerField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -92878,7 +246674,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -92886,7 +246712,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "clearValue", @@ -92894,7 +246731,18 @@ "desc" : "Clears any text/value currently set in the field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "collapse", @@ -92902,7 +246750,18 @@ "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -92910,7 +246769,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -92918,7 +246788,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "doQuery", @@ -92926,7 +246813,31 @@ "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.", "sig" : "(query, forceAll)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "query", + "type" : "String", + "desc" : "The SQL query to execute", + "isOptional" : false + }, + { + "name" : "forceAll", + "type" : "Boolean", + "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enable", @@ -92934,7 +246845,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "expand", @@ -92942,7 +246870,18 @@ "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -92950,7 +246889,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -92958,7 +246927,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getBox", @@ -92966,7 +246959,25 @@ "desc" : "Gets the current box measurements of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -92974,7 +246985,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -92982,7 +247010,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -92990,7 +247035,24 @@ "desc" : "Returns the name attribute of the field if available", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] }, { "name" : "getPosition", @@ -92998,7 +247060,31 @@ "desc" : "Gets the current XY position of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] }, { "name" : "getRawValue", @@ -93006,7 +247092,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getSize", @@ -93014,7 +247117,24 @@ "desc" : "Gets the current size of the component's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] }, { "name" : "getValue", @@ -93022,7 +247142,24 @@ "desc" : "Returns the currently selected field value or empty string if no value is set.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "value The selected value" + } + ] }, { "name" : "hasChanged", @@ -93030,7 +247167,18 @@ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -93038,7 +247186,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -93046,7 +247218,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isDirty", @@ -93054,7 +247243,18 @@ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isExpanded", @@ -93062,7 +247262,18 @@ "desc" : "Returns true if the dropdown list is expanded, else false.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValid", @@ -93070,7 +247281,31 @@ "desc" : "Returns whether or not the field value is currently valid", "sig" : "(preventMark)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "isVisible", @@ -93078,7 +247313,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -93086,7 +247332,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -93094,7 +247358,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onPosition", @@ -93102,7 +247402,31 @@ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onResize", @@ -93110,7 +247434,43 @@ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onTriggerClick", @@ -93118,7 +247478,25 @@ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.form.TriggerField" + "memberOf" : "Roo.form.TriggerField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -93126,7 +247504,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -93134,7 +247523,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -93142,7 +247549,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -93150,7 +247587,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -93158,7 +247613,18 @@ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "resetHasChanged", @@ -93166,7 +247632,18 @@ "desc" : "stores the current value in loadedValue", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "select", @@ -93174,7 +247651,31 @@ "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", "sig" : "(index, scrollIntoView)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The zero-based index of the list item to select", + "isOptional" : false + }, + { + "name" : "scrollIntoView", + "type" : "Boolean", + "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "selectByValue", @@ -93182,7 +247683,37 @@ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", "sig" : "(value, scrollIntoView)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The data value of the item to select", + "isOptional" : false + }, + { + "name" : "scrollIntoView", + "type" : "Boolean", + "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value matched an item in the list, else false" + } + ] }, { "name" : "selectText", @@ -93190,7 +247721,31 @@ "desc" : "Selects text in this field", "sig" : "(start, end)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDisabled", @@ -93198,7 +247753,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setEditable", @@ -93206,7 +247779,25 @@ "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Boolean", + "desc" : "True to allow the user to directly edit the field text", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setFromData", @@ -93214,7 +247805,25 @@ "desc" : "Sets the value of the field based on a object which is related to the record format for the store.", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Object", + "desc" : "the value to set as. or false on reset?", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPagePosition", @@ -93222,7 +247831,31 @@ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPosition", @@ -93230,7 +247863,31 @@ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", "sig" : "(left, top)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRawValue", @@ -93238,7 +247895,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setSize", @@ -93246,7 +247921,37 @@ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] }, { "name" : "setValue", @@ -93254,7 +247959,25 @@ "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The value to match", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -93262,7 +247985,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setWidth", @@ -93270,7 +248017,18 @@ "desc" : "", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "show", @@ -93278,7 +248036,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "syncSize", @@ -93286,7 +248061,18 @@ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -93294,7 +248080,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateBox", @@ -93302,7 +248118,25 @@ "desc" : "Sets the current box measurements of the component's underlying element.", "sig" : "(box)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "validate", @@ -93310,7 +248144,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -93318,7 +248169,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -93394,11 +248269,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "inputType", @@ -93503,147 +248374,492 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "confirm", "type" : "function", "desc" : "Fires when the 'confirm' icon is pressed (add a listener to enable add button)", "sig" : "function (combo)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.Signature", + "desc" : "This combo box", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires after the component is moved.", "sig" : "function (_self, x, y)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "reset", "type" : "function", "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)", "sig" : "function (combo, record)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "combo", + "type" : "Roo.form.ComboBox", + "desc" : "This combo box", + "isOptional" : false + }, + { + "name" : "record", + "type" : "Roo.data.Record|false", + "desc" : "The data record returned from the underlying store (or false on nothing selected)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires after the component is resized.", "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -93653,7 +248869,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -93661,7 +248895,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "applyTo", @@ -93669,7 +248939,31 @@ "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", "sig" : "(el)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] }, { "name" : "capture", @@ -93677,7 +248971,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -93685,7 +249009,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "createToolbar", @@ -93693,7 +249028,25 @@ "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.", "sig" : "(editor)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "editor", + "type" : "HtmlEditor", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", @@ -93701,7 +249054,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -93709,7 +249073,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -93717,7 +249098,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -93725,7 +249123,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -93733,7 +249161,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getBox", @@ -93741,7 +249193,25 @@ "desc" : "Gets the current box measurements of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getConfirmed", @@ -93749,7 +249219,24 @@ "desc" : "", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "this.isConfirmed" + } + ] }, { "name" : "getEl", @@ -93757,7 +249244,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getHeight", @@ -93765,7 +249269,24 @@ "desc" : "", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "this.height" + } + ] }, { "name" : "getId", @@ -93773,7 +249294,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getImageDataURI", @@ -93781,7 +249319,24 @@ "desc" : "when user is clicked confirm then show this image.....", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "Image Data URI" + } + ] }, { "name" : "getName", @@ -93789,7 +249344,24 @@ "desc" : "Returns the name attribute of the field if available", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] }, { "name" : "getPosition", @@ -93797,7 +249369,31 @@ "desc" : "Gets the current XY position of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] }, { "name" : "getRawValue", @@ -93805,7 +249401,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getSize", @@ -93813,7 +249426,24 @@ "desc" : "Gets the current size of the component's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] }, { "name" : "getValue", @@ -93821,7 +249451,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getWidth", @@ -93829,7 +249476,24 @@ "desc" : "", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "this.width" + } + ] }, { "name" : "hasChanged", @@ -93837,7 +249501,18 @@ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -93845,7 +249520,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -93853,7 +249552,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isDirty", @@ -93861,7 +249577,18 @@ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValid", @@ -93869,7 +249596,31 @@ "desc" : "Returns whether or not the field value is currently valid", "sig" : "(preventMark)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "isVisible", @@ -93877,7 +249628,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -93885,7 +249647,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -93893,7 +249673,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onPosition", @@ -93901,7 +249717,31 @@ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onResize", @@ -93909,7 +249749,43 @@ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -93917,7 +249793,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -93925,7 +249812,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -93933,7 +249838,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -93941,7 +249876,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -93949,7 +249902,18 @@ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "resetHasChanged", @@ -93957,7 +249921,18 @@ "desc" : "stores the current value in loadedValue", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setDisabled", @@ -93965,7 +249940,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setPagePosition", @@ -93973,7 +249966,31 @@ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPosition", @@ -93981,7 +249998,31 @@ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", "sig" : "(left, top)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRawValue", @@ -93989,7 +250030,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setSize", @@ -93997,7 +250056,37 @@ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] }, { "name" : "setValue", @@ -94005,7 +250094,25 @@ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -94013,7 +250120,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -94021,7 +250152,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "syncSize", @@ -94029,7 +250177,18 @@ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -94037,7 +250196,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateBox", @@ -94045,7 +250234,25 @@ "desc" : "Sets the current box measurements of the component's underlying element.", "sig" : "(box)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "validate", @@ -94053,7 +250260,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -94171,11 +250395,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "inputType", @@ -94340,140 +250560,472 @@ "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", "sig" : "function (_self, width)\n{\n\n}", - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires after the component is moved.", "sig" : "function (_self, x, y)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires after the component is resized.", "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -94483,7 +251035,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -94491,7 +251061,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "applyTo", @@ -94499,7 +251105,31 @@ "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", "sig" : "(el)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] }, { "name" : "autoSize", @@ -94507,7 +251137,18 @@ "desc" : "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -94515,7 +251156,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -94523,7 +251194,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -94531,7 +251213,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -94539,7 +251232,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -94547,7 +251257,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -94555,7 +251282,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -94563,7 +251320,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getBox", @@ -94571,7 +251352,25 @@ "desc" : "Gets the current box measurements of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -94579,7 +251378,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -94587,7 +251403,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -94595,7 +251428,24 @@ "desc" : "Returns the name attribute of the field if available", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] }, { "name" : "getPosition", @@ -94603,7 +251453,31 @@ "desc" : "Gets the current XY position of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] }, { "name" : "getRawValue", @@ -94611,7 +251485,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getSize", @@ -94619,7 +251510,24 @@ "desc" : "Gets the current size of the component's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] }, { "name" : "getValue", @@ -94627,7 +251535,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "hasChanged", @@ -94635,7 +251560,18 @@ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -94643,7 +251579,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -94651,7 +251611,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isDirty", @@ -94659,7 +251636,18 @@ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValid", @@ -94667,7 +251655,31 @@ "desc" : "Returns whether or not the field value is currently valid", "sig" : "(preventMark)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "isVisible", @@ -94675,7 +251687,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -94683,7 +251706,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -94691,7 +251732,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onPosition", @@ -94699,7 +251776,31 @@ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onResize", @@ -94707,7 +251808,43 @@ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -94715,7 +251852,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -94723,7 +251871,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -94731,7 +251897,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -94739,7 +251935,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -94747,7 +251961,18 @@ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "resetHasChanged", @@ -94755,7 +251980,18 @@ "desc" : "stores the current value in loadedValue", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "selectText", @@ -94763,7 +251999,31 @@ "desc" : "Selects text in this field", "sig" : "(start, end)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDisabled", @@ -94771,7 +252031,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setPagePosition", @@ -94779,7 +252057,31 @@ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPosition", @@ -94787,7 +252089,31 @@ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", "sig" : "(left, top)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRawValue", @@ -94795,7 +252121,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setSize", @@ -94803,7 +252147,37 @@ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] }, { "name" : "setValue", @@ -94811,7 +252185,25 @@ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -94819,7 +252211,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -94827,7 +252243,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "syncSize", @@ -94835,7 +252268,18 @@ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -94843,7 +252287,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateBox", @@ -94851,7 +252325,25 @@ "desc" : "Sets the current box measurements of the component's underlying element.", "sig" : "(box)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "validate", @@ -94859,7 +252351,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -94867,7 +252376,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -94985,11 +252518,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "inputType", @@ -95148,140 +252677,472 @@ "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", "sig" : "function (_self, width)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires after the component is moved.", "sig" : "function (_self, x, y)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires after the component is resized.", "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -95291,7 +253152,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -95299,7 +253178,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "applyTo", @@ -95307,7 +253222,31 @@ "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", "sig" : "(el)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] }, { "name" : "autoSize", @@ -95315,7 +253254,18 @@ "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -95323,7 +253273,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -95331,7 +253311,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -95339,7 +253330,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -95347,7 +253349,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -95355,7 +253374,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -95363,7 +253399,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -95371,7 +253437,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getBox", @@ -95379,7 +253469,25 @@ "desc" : "Gets the current box measurements of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -95387,7 +253495,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -95395,7 +253520,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -95403,7 +253545,24 @@ "desc" : "Returns the name attribute of the field if available", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] }, { "name" : "getPosition", @@ -95411,7 +253570,31 @@ "desc" : "Gets the current XY position of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] }, { "name" : "getRawValue", @@ -95419,7 +253602,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getSize", @@ -95427,7 +253627,24 @@ "desc" : "Gets the current size of the component's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] }, { "name" : "getValue", @@ -95435,7 +253652,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "hasChanged", @@ -95443,7 +253677,18 @@ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -95451,7 +253696,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -95459,7 +253728,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isDirty", @@ -95467,7 +253753,18 @@ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValid", @@ -95475,7 +253772,31 @@ "desc" : "Returns whether or not the field value is currently valid", "sig" : "(preventMark)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "isVisible", @@ -95483,7 +253804,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -95491,7 +253823,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -95499,7 +253849,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onPosition", @@ -95507,7 +253893,31 @@ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onResize", @@ -95515,7 +253925,43 @@ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -95523,7 +253969,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -95531,7 +253988,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -95539,7 +254014,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -95547,7 +254052,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -95555,7 +254078,18 @@ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "resetHasChanged", @@ -95563,7 +254097,18 @@ "desc" : "stores the current value in loadedValue", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "selectText", @@ -95571,7 +254116,31 @@ "desc" : "Selects text in this field", "sig" : "(start, end)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDisabled", @@ -95579,7 +254148,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setPagePosition", @@ -95587,7 +254174,31 @@ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPosition", @@ -95595,7 +254206,31 @@ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", "sig" : "(left, top)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRawValue", @@ -95603,7 +254238,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setSize", @@ -95611,7 +254264,37 @@ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] }, { "name" : "setValue", @@ -95619,7 +254302,25 @@ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -95627,7 +254328,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -95635,7 +254360,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "syncSize", @@ -95643,7 +254385,18 @@ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -95651,7 +254404,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateBox", @@ -95659,7 +254442,25 @@ "desc" : "Sets the current box measurements of the component's underlying element.", "sig" : "(box)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "validate", @@ -95667,7 +254468,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -95675,7 +254493,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -95709,11 +254551,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "html", @@ -95746,84 +254584,276 @@ "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires after the component is moved.", "sig" : "function (_self, x, y)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires after the component is resized.", "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -95833,7 +254863,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -95841,7 +254889,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -95849,7 +254933,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -95857,7 +254971,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -95865,7 +254990,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -95873,7 +255015,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -95881,7 +255040,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -95889,7 +255078,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getBox", @@ -95897,7 +255110,25 @@ "desc" : "Gets the current box measurements of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -95905,7 +255136,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -95913,7 +255161,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getPosition", @@ -95921,7 +255186,31 @@ "desc" : "Gets the current XY position of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] }, { "name" : "getSize", @@ -95929,7 +255218,24 @@ "desc" : "Gets the current size of the component's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] }, { "name" : "hasListener", @@ -95937,7 +255243,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -95945,7 +255275,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isVisible", @@ -95953,7 +255300,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -95961,7 +255319,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onPosition", @@ -95969,7 +255363,31 @@ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onResize", @@ -95977,7 +255395,43 @@ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -95985,7 +255439,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -95993,7 +255458,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -96001,7 +255484,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -96009,7 +255522,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -96017,7 +255548,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setPagePosition", @@ -96025,7 +255574,31 @@ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPosition", @@ -96033,7 +255606,31 @@ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", "sig" : "(left, top)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setSize", @@ -96041,7 +255638,37 @@ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] }, { "name" : "setVisible", @@ -96049,7 +255676,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -96057,7 +255708,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "syncSize", @@ -96065,7 +255733,18 @@ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -96073,7 +255752,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateBox", @@ -96081,7 +255790,25 @@ "desc" : "Sets the current box measurements of the component's underlying element.", "sig" : "(box)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -96181,11 +255908,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "hideTrigger", @@ -96356,140 +256079,472 @@ "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", "sig" : "function (_self, width)\n{\n\n}", - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "This text field", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new field width", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "blur", "type" : "function", "desc" : "Fires when this field loses input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "change", "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", "sig" : "function (_self, newValue, oldValue)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newValue", + "type" : "Mixed", + "desc" : "The new value", + "isOptional" : false + }, + { + "name" : "oldValue", + "type" : "Mixed", + "desc" : "The original value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focus", "type" : "function", "desc" : "Fires when this field receives input focus.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after the component is hidden.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "invalid", "type" : "function", "desc" : "Fires after the field has been marked as invalid.", "sig" : "function (_self, msg)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keyup", "type" : "function", "desc" : "Fires after the key up", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event Object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires after the component is moved.", "sig" : "function (_self, x, y)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires after the component is rendered.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "resize", "type" : "function", "desc" : "Fires after the component is resized.", "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + }, + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after the component is shown.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "valid", "type" : "function", "desc" : "Fires after the field has been validated with no errors.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -96499,7 +256554,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -96507,7 +256580,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "applyTo", @@ -96515,7 +256624,31 @@ "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", "sig" : "(el)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The id of the node, a DOM node or an existing Element", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.form.Field", + "desc" : "this" + } + ] }, { "name" : "autoSize", @@ -96523,7 +256656,18 @@ "desc" : "", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -96531,7 +256675,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearInvalid", @@ -96539,7 +256713,18 @@ "desc" : "Clear any invalid styles/messages for this field", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "destroy", @@ -96547,7 +256732,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -96555,7 +256751,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -96563,7 +256776,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -96571,7 +256801,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -96579,7 +256839,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getBox", @@ -96587,7 +256871,25 @@ "desc" : "Gets the current box measurements of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getEl", @@ -96595,7 +256897,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -96603,7 +256922,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getName", @@ -96611,7 +256947,24 @@ "desc" : "Returns the name attribute of the field if available", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "name The field name" + } + ] }, { "name" : "getPosition", @@ -96619,7 +256972,31 @@ "desc" : "Gets the current XY position of the component's underlying element.", "sig" : "(local)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "local", + "type" : "Boolean", + "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The XY position of the element (e.g., [100, 200])" + } + ] }, { "name" : "getRawValue", @@ -96627,7 +257004,24 @@ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "getSize", @@ -96635,7 +257029,24 @@ "desc" : "Gets the current size of the component's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the element's size {width: (element width), height: (element height)}" + } + ] }, { "name" : "getValue", @@ -96643,7 +257054,24 @@ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "value The field value" + } + ] }, { "name" : "hasChanged", @@ -96651,7 +257079,18 @@ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -96659,7 +257098,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -96667,7 +257130,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isDirty", @@ -96675,7 +257155,18 @@ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValid", @@ -96683,7 +257174,31 @@ "desc" : "Returns whether or not the field value is currently valid", "sig" : "(preventMark)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "preventMark", + "type" : "Boolean", + "desc" : "True to disable marking the field invalid", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "isVisible", @@ -96691,7 +257206,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "markInvalid", @@ -96699,7 +257225,25 @@ "desc" : "Mark this field as invalid", "sig" : "(msg)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "msg", + "type" : "String", + "desc" : "The validation message", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -96707,7 +257251,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onPosition", @@ -96715,7 +257295,31 @@ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onResize", @@ -96723,7 +257327,43 @@ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "adjWidth", + "type" : "Number", + "desc" : "The box-adjusted width that was set", + "isOptional" : false + }, + { + "name" : "adjHeight", + "type" : "Number", + "desc" : "The box-adjusted height that was set", + "isOptional" : false + }, + { + "name" : "rawWidth", + "type" : "Number", + "desc" : "The width that was originally specified", + "isOptional" : false + }, + { + "name" : "rawHeight", + "type" : "Number", + "desc" : "The height that was originally specified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onTriggerClick", @@ -96731,7 +257371,25 @@ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", "sig" : "(e)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -96739,7 +257397,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -96747,7 +257416,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -96755,7 +257442,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -96763,7 +257480,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "reset", @@ -96771,7 +257506,18 @@ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "resetHasChanged", @@ -96779,7 +257525,18 @@ "desc" : "stores the current value in loadedValue", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "selectText", @@ -96787,7 +257544,31 @@ "desc" : "Selects text in this field", "sig" : "(start, end)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "start", + "type" : "Number", + "desc" : "(optional) The index where the selection should start (defaults to 0)", + "isOptional" : false + }, + { + "name" : "end", + "type" : "Number", + "desc" : "(optional) The index where the selection should end (defaults to the text length)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDisabled", @@ -96795,7 +257576,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setPagePosition", @@ -96803,7 +257602,31 @@ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", "sig" : "(x, y)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "x", + "type" : "Number", + "desc" : "The new x position", + "isOptional" : false + }, + { + "name" : "y", + "type" : "Number", + "desc" : "The new y position", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPosition", @@ -96811,7 +257634,31 @@ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", "sig" : "(left, top)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "left", + "type" : "Number", + "desc" : "The new left", + "isOptional" : false + }, + { + "name" : "top", + "type" : "Number", + "desc" : "The new top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRawValue", @@ -96819,7 +257666,25 @@ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setSize", @@ -96827,7 +257692,37 @@ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number/Object", + "desc" : "The new width to set, or a size object in the format {width, height}", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height to set (not required if a size object is passed as the first arg)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.BoxComponent", + "desc" : "this" + } + ] }, { "name" : "setValue", @@ -96835,7 +257730,25 @@ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -96843,7 +257756,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -96851,7 +257788,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "syncSize", @@ -96859,7 +257813,18 @@ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -96867,7 +257832,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "updateBox", @@ -96875,7 +257870,25 @@ "desc" : "Sets the current box measurements of the component's underlying element.", "sig" : "(box)", "static" : false, - "memberOf" : "Roo.BoxComponent" + "memberOf" : "Roo.BoxComponent", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "box", + "type" : "Object", + "desc" : "An object in the format {x, y, width, height}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "validate", @@ -96883,7 +257896,24 @@ "desc" : "Validates the field value", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.form.Field" + "memberOf" : "Roo.form.Field", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] }, { "name" : "validateValue", @@ -96891,7 +257921,31 @@ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.form.TextField" + "memberOf" : "Roo.form.TextField", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to validate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the value is valid, else false" + } + ] } ] }, @@ -96905,7 +257959,25 @@ "desc" : "The function used to validate alpha values", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "alphanum'", @@ -96913,7 +257985,25 @@ "desc" : "The function used to validate alphanumeric values", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "email'", @@ -96921,7 +258011,25 @@ "desc" : "The function used to validate email addresses", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The email address", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "url'", @@ -96929,7 +258037,25 @@ "desc" : "The function used to validate URLs", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The URL", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -96939,9 +258065,398 @@ "methods" : [] }, "Roo.grid.AbstractGridView" : { - "props" : [], + "props" : [ + { + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable" + } + ], "events" : [], - "methods" : [] + "methods" : [ + { + "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" : "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" : [] + }, + { + "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" : "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" : "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" : "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" : "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" : "setCSSStyle", + "type" : "function", + "desc" : "Set a css style for a column dynamically.", + "sig" : "(colIndex, name, value)", + "static" : false, + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "colIndex", + "type" : "Number", + "desc" : "The index of the column", + "isOptional" : false + }, + { + "name" : "name", + "type" : "String", + "desc" : "The css property name", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String", + "desc" : "The css value", + "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" : [] + } + ] }, "Roo.grid.AbstractSelectionModel" : { "props" : [ @@ -96960,7 +258475,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -96968,7 +258501,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -96976,7 +258545,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "fireEvent", @@ -96984,7 +258583,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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", @@ -96992,7 +258621,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "isLocked", @@ -97000,7 +258653,24 @@ "desc" : "Returns true if the selections are locked.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "lock", @@ -97008,7 +258678,18 @@ "desc" : "Locks the selections.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -97016,7 +258697,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -97024,7 +258741,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -97032,7 +258760,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -97040,7 +258786,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "un", @@ -97048,7 +258824,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "unlock", @@ -97056,7 +258862,18 @@ "desc" : "Unlocks the selections.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -97075,245 +258892,982 @@ "type" : "function", "desc" : "Fires when the body element is scrolled", "sig" : "function (scrollLeft, scrollTop)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "scrollLeft", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scrollTop", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "cellclick", "type" : "function", "desc" : "Fires when a cell is clicked", "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "cellcontextmenu", "type" : "function", "desc" : "Fires when a cell is right clicked", "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "cellIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "celldblclick", "type" : "function", "desc" : "Fires when a cell is double clicked", "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "The raw click event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "columnmove", "type" : "function", "desc" : "Fires when the user moves a column", "sig" : "function (oldIndex, newIndex)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "oldIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "columnresize", "type" : "function", "desc" : "Fires when the user resizes a column", "sig" : "function (columnIndex, newSize)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "contextmenu", "type" : "function", "desc" : "The raw contextmenu event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dblclick", "type" : "function", "desc" : "The raw dblclick event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dragdrop", "type" : "function", "desc" : "Fires when dragged row(s) are dropped on a valid DD target", "sig" : "function (_self, dd, targetId, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dragenter", "type" : "function", "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged", "sig" : "function (_self, dd, targetId, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dragout", "type" : "function", "desc" : "Fires when the dragged row(s) leave another DD target while being dragged", "sig" : "function (_self, dd, targetId, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dragover", "type" : "function", "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.", "sig" : "function (_self, dd, targetId, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enddrag", "type" : "function", "desc" : "Fires when a drag operation is complete", "sig" : "function (_self, dd, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "eventclick", "type" : "function", "desc" : "Fires when the mouse click an", "sig" : "function (_self, )\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Calendar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "", + "type" : "event", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "evententer", "type" : "function", "desc" : "Fires when mouse over an event", "sig" : "function (_self, Event)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Calendar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "Event", + "type" : "event", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "eventleave", "type" : "function", "desc" : "Fires when the mouse leaves an", "sig" : "function (_self, )\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Calendar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "", + "type" : "event", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "eventrender", "type" : "function", "desc" : "Fires before each cell is rendered, so you can modify the contents, like cls / title / qtip", "sig" : "function (_self, data)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Calendar", + "desc" : "", + "isOptional" : false + }, + { + "name" : "data", + "type" : "data", + "desc" : "to be modified", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "headerclick", "type" : "function", "desc" : "Fires when a header is clicked", "sig" : "function (_self, columnIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "headercontextmenu", "type" : "function", "desc" : "Fires when a header is right clicked", "sig" : "function (_self, columnIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "headerdblclick", "type" : "function", "desc" : "Fires when a header cell is double clicked", "sig" : "function (_self, columnIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keydown", "type" : "function", "desc" : "The raw keydown event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keypress", "type" : "function", "desc" : "The raw keypress event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "monthchange", "type" : "function", "desc" : "Fires when the displayed month changes", "sig" : "function (_self, date)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "DatePicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Date", + "desc" : "The selected month", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mousedown", "type" : "function", "desc" : "The raw mousedown event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseout", "type" : "function", "desc" : "The raw mouseout event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseover", "type" : "function", "desc" : "The raw mouseover event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseup", "type" : "function", "desc" : "The raw mouseup event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires when the grid is rendered", "sig" : "function (grid)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "grid", + "type" : "Grid", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rowclass", "type" : "function", "desc" : "Fires when a row is rendered, so you can change add a style to it.", "sig" : "function (gridview, rowcfg)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "gridview", + "type" : "GridView", + "desc" : "The grid view", + "isOptional" : false + }, + { + "name" : "rowcfg", + "type" : "Object", + "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rowclick", "type" : "function", "desc" : "Fires when a row is clicked", "sig" : "function (_self, rowIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rowcontextmenu", "type" : "function", "desc" : "Fires when a row is right clicked", "sig" : "function (_self, rowIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rowdblclick", "type" : "function", "desc" : "Fires when a row is double clicked", "sig" : "function (_self, rowIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "select", "type" : "function", "desc" : "Fires when a date is selected", "sig" : "function (_self, date)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "DatePicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Date", + "desc" : "The selected date", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "startdrag", "type" : "function", "desc" : "Fires when row(s) start being dragged", "sig" : "function (_self, dd, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -97323,7 +259877,24 @@ "desc" : "Returns the grid's SelectionModel.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "SelectionModel", + "desc" : "" + } + ] } ] }, @@ -97348,35 +259919,130 @@ "type" : "function", "desc" : "Fires before the next editable sell is made active\nYou can use this to skip to another cell or fire the tabend\n if you set cell to false", "sig" : "function (eventdata)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventdata", + "type" : "Object", + "desc" : "object : { cell : [ row, col ] }", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforerowselect", "type" : "function", "desc" : "Fires before a cell is selected.", "sig" : "function (_self, rowIndex, colIndex)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "The selected row index", + "isOptional" : false + }, + { + "name" : "colIndex", + "type" : "Number", + "desc" : "The selected cell index", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "cellselect", "type" : "function", "desc" : "Fires when a cell is selected.", "sig" : "function (_self, rowIndex, colIndex)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "The selected row index", + "isOptional" : false + }, + { + "name" : "colIndex", + "type" : "Number", + "desc" : "The selected cell index", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "selectionchange", "type" : "function", "desc" : "Fires when the active selection changes.", "sig" : "function (_self, selection)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "selection", + "type" : "Object", + "desc" : "null for no selection or an object (o) with two properties\n\t ", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "tabend", "type" : "function", "desc" : "Fires when the tab (or enter) was pressed on the last editable cell\nYou can use this to trigger add new row.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -97386,7 +260052,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -97394,7 +260078,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -97402,7 +260122,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearSelections", @@ -97410,7 +260160,25 @@ "desc" : "Clears all selections.", "sig" : "(true)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "true", + "type" : "Boolean", + "desc" : "to prevent the gridview from being notified about the change.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -97418,7 +260186,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getSelectedCell", @@ -97426,7 +260224,24 @@ "desc" : "Returns the currently selected cell,.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "The selected cell (row, column) or null if none selected." + } + ] }, { "name" : "hasListener", @@ -97434,7 +260249,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hasSelection", @@ -97442,7 +260281,24 @@ "desc" : "Returns true if there is a selection.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isLocked", @@ -97450,7 +260306,24 @@ "desc" : "Returns true if the selections are locked.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.grid.AbstractSelectionModel" + "memberOf" : "Roo.grid.AbstractSelectionModel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "lock", @@ -97458,7 +260331,18 @@ "desc" : "Locks the selections.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.grid.AbstractSelectionModel" + "memberOf" : "Roo.grid.AbstractSelectionModel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -97466,7 +260350,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onEditorKey", @@ -97474,7 +260394,31 @@ "desc" : "Selects a cell.", "sig" : "(field, e)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "field", + "type" : "Number", + "desc" : "(not used) - as it's normally used as a listener", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Number", + "desc" : "- event - fake it by using\n\nvar e = Roo.EventObjectImpl.prototype;\ne.keyCode = e.TAB", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "purgeListeners", @@ -97482,7 +260426,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -97490,7 +260445,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -97498,7 +260471,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "select", @@ -97506,7 +260509,31 @@ "desc" : "Selects a cell.", "sig" : "(rowIndex, collIndex)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "collIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "un", @@ -97514,7 +260541,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "unlock", @@ -97522,7 +260579,18 @@ "desc" : "Unlocks the selections.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.grid.AbstractSelectionModel" + "memberOf" : "Roo.grid.AbstractSelectionModel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -97685,35 +260753,160 @@ "type" : "function", "desc" : "Fires when a column's locked state is changed", "sig" : "function (_self, colIndex, locked)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "ColumnModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "colIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "locked", + "type" : "Boolean", + "desc" : "true if locked", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "columnmoved", "type" : "function", "desc" : "Fires when a column is moved.", "sig" : "function (_self, oldIndex, newIndex)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "ColumnModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "oldIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "headerchange", "type" : "function", "desc" : "Fires when the text of a header changes.", "sig" : "function (_self, columnIndex, newText)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "ColumnModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "newText", + "type" : "Number", + "desc" : "The new header text", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hiddenchange", "type" : "function", "desc" : "Fires when a column is hidden or \"unhidden\".", "sig" : "function (_self, columnIndex, hidden)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "ColumnModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "true if hidden, false otherwise", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "widthchange", "type" : "function", "desc" : "Fires when the width of a column changes.", "sig" : "function (_self, columnIndex, newWidth)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "ColumnModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "newWidth", + "type" : "Number", + "desc" : "The new width", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -97723,7 +260916,25 @@ "desc" : "Add a column (experimental...) - defaults to adding to the end..", "sig" : "(config)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addEvents", @@ -97731,7 +260942,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -97739,7 +260968,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -97747,7 +261012,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "findColumnIndex", @@ -97755,7 +261050,31 @@ "desc" : "Returns the index for a specified column dataIndex.", "sig" : "(dataIndex)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "dataIndex", + "type" : "String", + "desc" : "The column dataIndex", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "the index, or -1 if not found" + } + ] }, { "name" : "fireEvent", @@ -97763,7 +261082,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getCellEditor", @@ -97771,7 +261120,37 @@ "desc" : "Returns the editor defined for the cell/column.\nreturn false or null to disable editing.", "sig" : "(colIndex, rowIndex)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "colIndex", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "The row index", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "" + } + ] }, { "name" : "getColumnByDataIndex", @@ -97779,7 +261158,31 @@ "desc" : "Returns the column Object for a specified dataIndex.", "sig" : "(dataIndex)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "dataIndex", + "type" : "String", + "desc" : "The column dataIndex", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object|Boolean", + "desc" : "the column or false if not found" + } + ] }, { "name" : "getColumnById", @@ -97787,7 +261190,31 @@ "desc" : "Returns the column for a specified id.", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The column id", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "the column" + } + ] }, { "name" : "getColumnCount", @@ -97795,7 +261222,24 @@ "desc" : "Returns the number of columns.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] }, { "name" : "getColumnHeader", @@ -97803,7 +261247,31 @@ "desc" : "Returns the header for the specified column.", "sig" : "(col)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getColumnId", @@ -97811,7 +261279,31 @@ "desc" : "Returns the id of the column at the specified index.", "sig" : "(index)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "the id" + } + ] }, { "name" : "getColumnTooltip", @@ -97819,7 +261311,31 @@ "desc" : "Returns the tooltip for the specified column.", "sig" : "(col)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getColumnWidth", @@ -97827,7 +261343,37 @@ "desc" : "Returns the width for the specified column.", "sig" : "(col, (optional))", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "(optional)", + "type" : "", + "desc" : "{String} gridSize bootstrap width size.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] }, { "name" : "getColumnsBy", @@ -97835,7 +261381,37 @@ "desc" : "Returns the column configs that return true by the passed function that is called with (columnConfig, index)", "sig" : "(fn, scope)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "result" + } + ] }, { "name" : "getDataIndex", @@ -97843,7 +261419,31 @@ "desc" : "Returns the dataIndex for the specified column.", "sig" : "(col)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] }, { "name" : "getIndexById", @@ -97851,7 +261451,31 @@ "desc" : "Returns the index for a specified column id.", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The column id", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "the index, or -1 if not found" + } + ] }, { "name" : "getRenderer", @@ -97859,7 +261483,31 @@ "desc" : "Returns the rendering (formatting) function defined for the column.", "sig" : "(col)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Function", + "desc" : "The function used to render the cell. See {@link #setRenderer}." + } + ] }, { "name" : "getTotalWidth", @@ -97867,7 +261515,31 @@ "desc" : "Returns the total width of all columns.", "sig" : "(includeHidden)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "includeHidden", + "type" : "Boolean", + "desc" : "True to include hidden column widths", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -97875,7 +261547,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "isCellEditable", @@ -97883,7 +261579,37 @@ "desc" : "Returns true if the cell is editable.", "sig" : "(colIndex, rowIndex)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "colIndex", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "The row index - this is nto actually used..?", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isFixed", @@ -97891,7 +261617,18 @@ "desc" : "Returns true if the column width cannot be changed", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isHidden", @@ -97899,7 +261636,31 @@ "desc" : "Returns true if the column is hidden.", "sig" : "(colIndex)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "colIndex", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isResizable", @@ -97907,7 +261668,24 @@ "desc" : "Returns true if the column can be resized", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isSortable", @@ -97915,7 +261693,31 @@ "desc" : "Returns true if the specified column is sortable.", "sig" : "(col)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "on", @@ -97923,7 +261725,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -97931,7 +261769,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -97939,7 +261788,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -97947,7 +261814,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "setColumnHeader", @@ -97955,7 +261852,31 @@ "desc" : "Sets the header for a column.", "sig" : "(col, header)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "header", + "type" : "String", + "desc" : "The new header", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setColumnTooltip", @@ -97963,7 +261884,31 @@ "desc" : "Sets the tooltip for a column.", "sig" : "(col, tooltip)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "tooltip", + "type" : "String", + "desc" : "The new tooltip", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setColumnWidth", @@ -97971,7 +261916,31 @@ "desc" : "Sets the width for a column.", "sig" : "(col, width)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "width", + "type" : "Number", + "desc" : "The new width", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDataIndex", @@ -97979,7 +261948,31 @@ "desc" : "Sets the dataIndex for a column.", "sig" : "(col, dataIndex)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "dataIndex", + "type" : "Number", + "desc" : "The new dataIndex", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setEditable", @@ -97987,7 +261980,31 @@ "desc" : "Sets if a column is editable.", "sig" : "(col, editable)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "editable", + "type" : "Boolean", + "desc" : "True if the column is editable", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setEditor", @@ -97995,7 +262012,31 @@ "desc" : "Sets the editor for a column.", "sig" : "(col, editor)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "editor", + "type" : "Object", + "desc" : "The editor object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setHidden", @@ -98003,7 +262044,31 @@ "desc" : "Sets if a column is hidden.", "sig" : "(colIndex, hidden)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "colIndex", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "hidden", + "type" : "Boolean", + "desc" : "True if the column is hidden", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRenderer", @@ -98011,7 +262076,31 @@ "desc" : "Sets the rendering (formatting) function for a column.", "sig" : "(col, fn)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to use to process the cell's raw data\nto return HTML markup for the grid view. The render function is called with\nthe following parameters:", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "un", @@ -98019,7 +262108,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -98073,6 +262192,12 @@ "desc" : "The number of clicks on a cell required to display the cell's editor (defaults to 2)", "memberOf" : "" }, + { + "name" : "cm[]", + "type" : "Roo.grid.ColumnModel", + "desc" : "The columns of the grid", + "memberOf" : "Roo.grid.Grid" + }, { "name" : "ddGroup", "type" : "String", @@ -98097,6 +262222,12 @@ "desc" : "An {@link Roo.dd.DropTarget} config", "memberOf" : "Roo.grid.Grid" }, + { + "name" : "ds", + "type" : "Roo.grid.Store", + "desc" : "The data store for the grid", + "memberOf" : "Roo.grid.Grid" + }, { "name" : "enableColumnHide", "type" : "Boolean", @@ -98169,12 +262300,24 @@ "desc" : "True to autoSize the grid when the window resizes. Default is true.", "memberOf" : "Roo.grid.Grid" }, + { + "name" : "sm", + "type" : "Roo.grid.AbstractSelectionModel", + "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)", + "memberOf" : "Roo.grid.Grid" + }, { "name" : "stripeRows", "type" : "Boolean", "desc" : "True to stripe the rows. Default is true.", "memberOf" : "Roo.grid.Grid" }, + { + "name" : "toolbar", + "type" : "Roo.Toolbar", + "desc" : "a toolbar for buttons etc.", + "memberOf" : "Roo.grid.Grid" + }, { "name" : "trackMouseOver", "type" : "Boolean", @@ -98183,8 +262326,8 @@ }, { "name" : "view", - "type" : "Object", - "desc" : "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().", + "type" : "Roo.grid.GridView", + "desc" : "The view that renders the grid (default = Roo.grid.GridView)", "memberOf" : "Roo.grid.Grid" } ], @@ -98194,224 +262337,886 @@ "type" : "function", "desc" : "Fires after a cell is edited.
\n", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Object", + "desc" : "An edit event (see above for description)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeedit", "type" : "function", "desc" : "Fires before cell editing is triggered. The edit event object has the following properties
\n", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Object", + "desc" : "An edit event (see above for description)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "bodyscroll", "type" : "function", "desc" : "Fires when the body element is scrolled", "sig" : "function (scrollLeft, scrollTop)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "scrollLeft", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scrollTop", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "cellclick", "type" : "function", "desc" : "Fires when a cell is clicked", "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "cellcontextmenu", "type" : "function", "desc" : "Fires when a cell is right clicked", "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "cellIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "celldblclick", "type" : "function", "desc" : "Fires when a cell is double clicked", "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "The raw click event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "columnmove", "type" : "function", "desc" : "Fires when the user moves a column", "sig" : "function (oldIndex, newIndex)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "oldIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "columnresize", "type" : "function", "desc" : "Fires when the user resizes a column", "sig" : "function (columnIndex, newSize)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "contextmenu", "type" : "function", "desc" : "The raw contextmenu event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dblclick", "type" : "function", "desc" : "The raw dblclick event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dragdrop", "type" : "function", "desc" : "Fires when dragged row(s) are dropped on a valid DD target", "sig" : "function (_self, dd, targetId, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dragenter", "type" : "function", "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged", "sig" : "function (_self, dd, targetId, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dragout", "type" : "function", "desc" : "Fires when the dragged row(s) leave another DD target while being dragged", "sig" : "function (_self, dd, targetId, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dragover", "type" : "function", "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.", "sig" : "function (_self, dd, targetId, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enddrag", "type" : "function", "desc" : "Fires when a drag operation is complete", "sig" : "function (_self, dd, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "headerclick", "type" : "function", "desc" : "Fires when a header is clicked", "sig" : "function (_self, columnIndex, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "headercontextmenu", "type" : "function", "desc" : "Fires when a header is right clicked", "sig" : "function (_self, columnIndex, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "headerdblclick", "type" : "function", "desc" : "Fires when a header cell is double clicked", "sig" : "function (_self, columnIndex, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keydown", "type" : "function", "desc" : "The raw keydown event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keypress", "type" : "function", "desc" : "The raw keypress event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mousedown", "type" : "function", "desc" : "The raw mousedown event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseout", "type" : "function", "desc" : "The raw mouseout event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseover", "type" : "function", "desc" : "The raw mouseover event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseup", "type" : "function", "desc" : "The raw mouseup event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires when the grid is rendered", "sig" : "function (grid)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "grid", + "type" : "Grid", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rowclass", "type" : "function", "desc" : "Fires when a row is rendered, so you can change add a style to it.", "sig" : "function (gridview, rowcfg)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "gridview", + "type" : "GridView", + "desc" : "The grid view", + "isOptional" : false + }, + { + "name" : "rowcfg", + "type" : "Object", + "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rowclick", "type" : "function", "desc" : "Fires when a row is clicked", "sig" : "function (_self, rowIndex, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rowcontextmenu", "type" : "function", "desc" : "Fires when a row is right clicked", "sig" : "function (_self, rowIndex, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rowdblclick", "type" : "function", "desc" : "Fires when a row is double clicked", "sig" : "function (_self, rowIndex, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "startdrag", "type" : "function", "desc" : "Fires when row(s) start being dragged", "sig" : "function (_self, dd, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "validateedit", "type" : "function", "desc" : "Fires after a cell is edited, but before the value is set in the record. \nYou can use this to modify the value being set in the field, Return false\nto cancel the change. The edit event object has the following properties
\n", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Object", + "desc" : "An edit event (see above for description)", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -98421,7 +263226,31 @@ "desc" : "addColumns\nAdd's a column, default at the end..", "sig" : "(position, of)", "static" : false, - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "position", + "type" : "int", + "desc" : "to add (default end)", + "isOptional" : false + }, + { + "name" : "of", + "type" : "Array", + "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addEvents", @@ -98429,7 +263258,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -98437,7 +263284,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "autoSize", @@ -98445,7 +263328,18 @@ "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -98453,7 +263347,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -98461,7 +263385,25 @@ "desc" : "Destroy this grid.", "sig" : "(removeEl)", "static" : false, - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "removeEl", + "type" : "Boolean", + "desc" : "True to remove the element", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -98469,7 +263411,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getColumnModel", @@ -98477,7 +263449,24 @@ "desc" : "Returns the grid's ColumnModel.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "ColumnModel", + "desc" : "" + } + ] }, { "name" : "getDataSource", @@ -98485,7 +263474,24 @@ "desc" : "Returns the grid's DataSource.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "DataSource", + "desc" : "" + } + ] }, { "name" : "getDragDropText", @@ -98493,7 +263499,24 @@ "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getGridEl", @@ -98501,7 +263524,24 @@ "desc" : "Returns the grid's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "The element" + } + ] }, { "name" : "getSelectionModel", @@ -98509,7 +263549,24 @@ "desc" : "Returns the grid's SelectionModel.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "SelectionModel", + "desc" : "" + } + ] }, { "name" : "getView", @@ -98517,7 +263574,24 @@ "desc" : "Returns the grid's GridView object.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "GridView", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -98525,7 +263599,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "on", @@ -98533,7 +263631,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -98541,7 +263675,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "reconfigure", @@ -98549,7 +263694,31 @@ "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.", "sig" : "(dataSource, The)", "static" : false, - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "dataSource", + "type" : "Roo.data.Store", + "desc" : "The new {@link Roo.data.Store} object", + "isOptional" : false + }, + { + "name" : "The", + "type" : "Roo.grid.ColumnModel", + "desc" : "new {@link Roo.grid.ColumnModel} object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "releaseCapture", @@ -98557,7 +263726,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -98565,7 +263752,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -98573,7 +263790,24 @@ "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.grid.Grid", + "desc" : "this" + } + ] }, { "name" : "startEditing", @@ -98581,7 +263815,31 @@ "desc" : "Starts editing the specified for the specified row/column", "sig" : "(rowIndex, colIndex)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "colIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "stopEditing", @@ -98589,7 +263847,18 @@ "desc" : "Stops any active editing", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -98597,7 +263866,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -98645,6 +263944,12 @@ "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.", "memberOf" : "" }, + { + "name" : "cm[]", + "type" : "Roo.grid.ColumnModel", + "desc" : "The columns of the grid", + "memberOf" : "" + }, { "name" : "ddGroup", "type" : "String", @@ -98669,6 +263974,12 @@ "desc" : "An {@link Roo.dd.DropTarget} config", "memberOf" : "" }, + { + "name" : "ds", + "type" : "Roo.grid.Store", + "desc" : "The data store for the grid", + "memberOf" : "" + }, { "name" : "enableColumnHide", "type" : "Boolean", @@ -98741,12 +264052,24 @@ "desc" : "True to autoSize the grid when the window resizes. Default is true.", "memberOf" : "" }, + { + "name" : "sm", + "type" : "Roo.grid.AbstractSelectionModel", + "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)", + "memberOf" : "" + }, { "name" : "stripeRows", "type" : "Boolean", "desc" : "True to stripe the rows. Default is true.", "memberOf" : "" }, + { + "name" : "toolbar", + "type" : "Roo.Toolbar", + "desc" : "a toolbar for buttons etc.", + "memberOf" : "" + }, { "name" : "trackMouseOver", "type" : "Boolean", @@ -98755,8 +264078,8 @@ }, { "name" : "view", - "type" : "Object", - "desc" : "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().", + "type" : "Roo.grid.GridView", + "desc" : "The view that renders the grid (default = Roo.grid.GridView)", "memberOf" : "" } ], @@ -98766,203 +264089,826 @@ "type" : "function", "desc" : "Fires when the body element is scrolled", "sig" : "function (scrollLeft, scrollTop)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "scrollLeft", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scrollTop", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "cellclick", "type" : "function", "desc" : "Fires when a cell is clicked", "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "cellcontextmenu", "type" : "function", "desc" : "Fires when a cell is right clicked", "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "cellIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "celldblclick", "type" : "function", "desc" : "Fires when a cell is double clicked", "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "The raw click event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "columnmove", "type" : "function", "desc" : "Fires when the user moves a column", "sig" : "function (oldIndex, newIndex)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "oldIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "columnresize", "type" : "function", "desc" : "Fires when the user resizes a column", "sig" : "function (columnIndex, newSize)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "contextmenu", "type" : "function", "desc" : "The raw contextmenu event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dblclick", "type" : "function", "desc" : "The raw dblclick event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dragdrop", "type" : "function", "desc" : "Fires when dragged row(s) are dropped on a valid DD target", "sig" : "function (_self, dd, targetId, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dragenter", "type" : "function", "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged", "sig" : "function (_self, dd, targetId, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dragout", "type" : "function", "desc" : "Fires when the dragged row(s) leave another DD target while being dragged", "sig" : "function (_self, dd, targetId, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dragover", "type" : "function", "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.", "sig" : "function (_self, dd, targetId, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enddrag", "type" : "function", "desc" : "Fires when a drag operation is complete", "sig" : "function (_self, dd, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "headerclick", "type" : "function", "desc" : "Fires when a header is clicked", "sig" : "function (_self, columnIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "headercontextmenu", "type" : "function", "desc" : "Fires when a header is right clicked", "sig" : "function (_self, columnIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "headerdblclick", "type" : "function", "desc" : "Fires when a header cell is double clicked", "sig" : "function (_self, columnIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keydown", "type" : "function", "desc" : "The raw keydown event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keypress", "type" : "function", "desc" : "The raw keypress event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mousedown", "type" : "function", "desc" : "The raw mousedown event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseout", "type" : "function", "desc" : "The raw mouseout event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseover", "type" : "function", "desc" : "The raw mouseover event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseup", "type" : "function", "desc" : "The raw mouseup event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires when the grid is rendered", "sig" : "function (grid)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "grid", + "type" : "Grid", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rowclass", "type" : "function", "desc" : "Fires when a row is rendered, so you can change add a style to it.", "sig" : "function (gridview, rowcfg)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "gridview", + "type" : "GridView", + "desc" : "The grid view", + "isOptional" : false + }, + { + "name" : "rowcfg", + "type" : "Object", + "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rowclick", "type" : "function", "desc" : "Fires when a row is clicked", "sig" : "function (_self, rowIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rowcontextmenu", "type" : "function", "desc" : "Fires when a row is right clicked", "sig" : "function (_self, rowIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rowdblclick", "type" : "function", "desc" : "Fires when a row is double clicked", "sig" : "function (_self, rowIndex, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "startdrag", "type" : "function", "desc" : "Fires when row(s) start being dragged", "sig" : "function (_self, dd, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -98972,7 +264918,31 @@ "desc" : "addColumns\nAdd's a column, default at the end..", "sig" : "(position, of)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "position", + "type" : "int", + "desc" : "to add (default end)", + "isOptional" : false + }, + { + "name" : "of", + "type" : "Array", + "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addEvents", @@ -98980,7 +264950,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -98988,7 +264976,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "autoSize", @@ -98996,7 +265020,18 @@ "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -99004,7 +265039,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -99012,7 +265077,25 @@ "desc" : "Destroy this grid.", "sig" : "(removeEl)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "removeEl", + "type" : "Boolean", + "desc" : "True to remove the element", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -99020,7 +265103,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getColumnModel", @@ -99028,7 +265141,24 @@ "desc" : "Returns the grid's ColumnModel.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "ColumnModel", + "desc" : "" + } + ] }, { "name" : "getDataSource", @@ -99036,7 +265166,24 @@ "desc" : "Returns the grid's DataSource.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "DataSource", + "desc" : "" + } + ] }, { "name" : "getDragDropText", @@ -99044,7 +265191,24 @@ "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.\nOverride this to put something different in the dragged text.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getGridEl", @@ -99052,7 +265216,24 @@ "desc" : "Returns the grid's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "The element" + } + ] }, { "name" : "getSelectionModel", @@ -99060,7 +265241,24 @@ "desc" : "Returns the grid's SelectionModel.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "SelectionModel", + "desc" : "" + } + ] }, { "name" : "getView", @@ -99068,7 +265266,24 @@ "desc" : "Returns the grid's GridView object.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "GridView", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -99076,7 +265291,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "on", @@ -99084,7 +265323,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -99092,7 +265367,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "reconfigure", @@ -99100,7 +265386,31 @@ "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.", "sig" : "(dataSource, The)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "dataSource", + "type" : "Roo.data.Store", + "desc" : "The new {@link Roo.data.Store} object", + "isOptional" : false + }, + { + "name" : "The", + "type" : "Roo.grid.ColumnModel", + "desc" : "new {@link Roo.grid.ColumnModel} object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "releaseCapture", @@ -99108,7 +265418,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -99116,7 +265444,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -99124,7 +265482,24 @@ "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.grid.Grid", + "desc" : "this" + } + ] }, { "name" : "un", @@ -99132,7 +265507,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -99202,11 +265607,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "ignoreNoChange", @@ -99251,105 +265652,348 @@ "type" : "function", "desc" : "Fires after a change has been made to the field, but before the change is reflected in the underlying\nfield. Saving the change to the field can be canceled by returning false from the handler of this event.\nNote that if the value has not changed and ignoreNoChange = true, the editing will still end but this\nevent will not fire since no edit actually occurred.", "sig" : "function (_self, value, startValue)\n{\n\n}", - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Editor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The current field value", + "isOptional" : false + }, + { + "name" : "startValue", + "type" : "Mixed", + "desc" : "The original field value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforestartedit", "type" : "function", "desc" : "Fires when editing is initiated, but before the value changes. Editing can be canceled by returning\nfalse from the handler of this event.", "sig" : "function (_self, boundEl, value)\n{\n\n}", - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Editor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "boundEl", + "type" : "Roo.Element", + "desc" : "The underlying element bound to this editor", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The field value being set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "complete", "type" : "function", "desc" : "Fires after editing is complete and any changed value has been written to the underlying field.", "sig" : "function (_self, value, startValue)\n{\n\n}", - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Editor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The current field value", + "isOptional" : false + }, + { + "name" : "startValue", + "type" : "Mixed", + "desc" : "The original field value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "startedit", "type" : "function", "desc" : "Fires when this editor is displayed", "sig" : "function (boundEl, value)\n{\n\n}", - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "boundEl", + "type" : "Roo.Element", + "desc" : "The underlying element bound to this editor", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The starting field value", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -99359,7 +266003,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -99367,7 +266029,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "cancelEdit", @@ -99375,7 +266073,25 @@ "desc" : "Cancels the editing process and hides the editor without persisting any changes. The field value will be\nreverted to the original starting value.", "sig" : "(remainVisible)", "static" : false, - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "remainVisible", + "type" : "Boolean", + "desc" : "Override the default behavior and keep the editor visible after\ncancel (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "capture", @@ -99383,7 +266099,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "completeEdit", @@ -99391,7 +266137,25 @@ "desc" : "Ends the editing process, persists the changed value to the underlying field, and hides the editor.", "sig" : "(remainVisible)", "static" : false, - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "remainVisible", + "type" : "Boolean", + "desc" : "Override the default behavior and keep the editor visible after edit (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", @@ -99399,7 +266163,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -99407,7 +266182,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -99415,7 +266207,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -99423,7 +266232,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -99431,7 +266270,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getEl", @@ -99439,7 +266302,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -99447,7 +266327,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getValue", @@ -99455,7 +266352,24 @@ "desc" : "Gets the data value of the editor", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "The data value" + } + ] }, { "name" : "hasListener", @@ -99463,7 +266377,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -99471,7 +266409,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isVisible", @@ -99479,7 +266434,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -99487,7 +266453,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -99495,7 +266497,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "realign", @@ -99503,7 +266516,18 @@ "desc" : "Realigns the editor to the bound field based on the current alignment config value.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -99511,7 +266535,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -99519,7 +266561,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -99527,7 +266599,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -99535,7 +266625,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setSize", @@ -99543,7 +266651,31 @@ "desc" : "Sets the height and width of this editor.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number", + "desc" : "The new width", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setValue", @@ -99551,7 +266683,25 @@ "desc" : "Sets the data value of the editor", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "Any valid value supported by the underlying field", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -99559,7 +266709,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -99567,7 +266741,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "startEdit", @@ -99575,7 +266766,31 @@ "desc" : "Starts the editing process and shows the editor.", "sig" : "(el, value)", "static" : false, - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The element to edit", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String", + "desc" : "(optional) A value to initialize the editor with. If a value is not provided, it defaults\nto the innerHTML of el.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "un", @@ -99583,7 +266798,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -99604,7 +266849,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -99612,7 +266875,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "autoSizeColumn", @@ -99620,7 +266919,31 @@ "desc" : "Autofit a column to its content.", "sig" : "(colIndex, forceMinSize)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "colIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "forceMinSize", + "type" : "Boolean", + "desc" : "true to force the column to go smaller if possible", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "autoSizeColumns", @@ -99628,7 +266951,18 @@ "desc" : "Autofits all columns to their content and then expands to fit any extra space in the grid", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -99636,7 +266970,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "ensureVisible", @@ -99644,7 +267008,37 @@ "desc" : "Scrolls the specified cell into view", "sig" : "(row, col, hscroll)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "row", + "type" : "Number", + "desc" : "The row index", + "isOptional" : false + }, + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "hscroll", + "type" : "Boolean", + "desc" : "false to disable horizontal scrolling", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -99652,7 +267046,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "fitColumns", @@ -99660,7 +267084,25 @@ "desc" : "Autofits all columns to the grid's width proportionate with their current size", "sig" : "(reserveScrollSpace)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "reserveScrollSpace", + "type" : "Boolean", + "desc" : "Reserve space for a scrollbar", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focusCell", @@ -99668,7 +267110,37 @@ "desc" : "Focuses the specified cell.", "sig" : "(row, col, hscroll)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "row", + "type" : "Number", + "desc" : "The row index", + "isOptional" : false + }, + { + "name" : "col", + "type" : "Number", + "desc" : "The column index", + "isOptional" : false + }, + { + "name" : "hscroll", + "type" : "Boolean", + "desc" : "false to disable horizontal scrolling", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "focusRow", @@ -99676,7 +267148,25 @@ "desc" : "Focuses the specified row.", "sig" : "(row)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "row", + "type" : "Number", + "desc" : "The row index", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "getCell", @@ -99684,7 +267174,37 @@ "desc" : "Gets the 'td' of the cell", "sig" : "(rowIndex, colIndex)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "rowIndex", + "type" : "Integer", + "desc" : "row to select", + "isOptional" : false + }, + { + "name" : "colIndex", + "type" : "Integer", + "desc" : "column to select", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "" + } + ] }, { "name" : "getFooterPanel", @@ -99692,7 +267212,31 @@ "desc" : "Gets a panel in the footer of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size.", "sig" : "(doShow)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "doShow", + "type" : "Boolean", + "desc" : "By default the footer is hidden. Pass true to show the panel", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Roo.Element" + } + ] }, { "name" : "getHeaderPanel", @@ -99700,7 +267244,31 @@ "desc" : "Gets a panel in the header of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size.", "sig" : "(doShow)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "doShow", + "type" : "Boolean", + "desc" : "By default the header is hidden. Pass true to show the panel", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "Roo.Element" + } + ] }, { "name" : "hasListener", @@ -99708,7 +267276,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "on", @@ -99716,7 +267308,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -99724,7 +267352,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "refresh", @@ -99732,7 +267371,25 @@ "desc" : "Refreshes the grid", "sig" : "(headersToo)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "headersToo", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "releaseCapture", @@ -99740,7 +267397,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -99748,7 +267423,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "scrollToTop", @@ -99756,7 +267461,18 @@ "desc" : "Scrolls the grid to the top", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -99764,7 +267480,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -99818,6 +267564,12 @@ "desc" : "The number of clicks on a cell required to display the cell's editor (defaults to 2)", "memberOf" : "Roo.grid.EditorGrid" }, + { + "name" : "cm[]", + "type" : "Roo.grid.ColumnModel", + "desc" : "The columns of the grid", + "memberOf" : "Roo.grid.Grid" + }, { "name" : "customEditors", "type" : "Object", @@ -99848,6 +267600,12 @@ "desc" : "An {@link Roo.dd.DropTarget} config", "memberOf" : "Roo.grid.Grid" }, + { + "name" : "ds", + "type" : "Roo.grid.Store", + "desc" : "The data store for the grid", + "memberOf" : "Roo.grid.Grid" + }, { "name" : "enableColumnHide", "type" : "Boolean", @@ -99926,12 +267684,24 @@ "desc" : "map of property Names to their displayed value", "memberOf" : "" }, + { + "name" : "sm", + "type" : "Roo.grid.AbstractSelectionModel", + "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)", + "memberOf" : "Roo.grid.Grid" + }, { "name" : "stripeRows", "type" : "Boolean", "desc" : "True to stripe the rows. Default is true.", "memberOf" : "Roo.grid.Grid" }, + { + "name" : "toolbar", + "type" : "Roo.Toolbar", + "desc" : "a toolbar for buttons etc.", + "memberOf" : "Roo.grid.Grid" + }, { "name" : "trackMouseOver", "type" : "Boolean", @@ -99940,8 +267710,8 @@ }, { "name" : "view", - "type" : "Object", - "desc" : "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().", + "type" : "Roo.grid.GridView", + "desc" : "The view that renders the grid (default = Roo.grid.GridView)", "memberOf" : "Roo.grid.Grid" } ], @@ -99951,238 +267721,962 @@ "type" : "function", "desc" : "Fires after a cell is edited.
\n", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.grid.EditorGrid" + "memberOf" : "Roo.grid.EditorGrid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Object", + "desc" : "An edit event (see above for description)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeedit", "type" : "function", "desc" : "Fires before cell editing is triggered. The edit event object has the following properties
\n", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.grid.EditorGrid" + "memberOf" : "Roo.grid.EditorGrid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Object", + "desc" : "An edit event (see above for description)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforepropertychange", "type" : "function", "desc" : "Fires before a property changes (return false to stop?)", "sig" : "function (grid, id, newval, oldval)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "grid", + "type" : "Roo.grid.PropertyGrid", + "desc" : "property grid? (check could be store)", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "Record Id", + "isOptional" : false + }, + { + "name" : "newval", + "type" : "String", + "desc" : "New Value", + "isOptional" : false + }, + { + "name" : "oldval", + "type" : "String", + "desc" : "Old Value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "bodyscroll", "type" : "function", "desc" : "Fires when the body element is scrolled", "sig" : "function (scrollLeft, scrollTop)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "scrollLeft", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scrollTop", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "cellclick", "type" : "function", "desc" : "Fires when a cell is clicked", "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "cellcontextmenu", "type" : "function", "desc" : "Fires when a cell is right clicked", "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "cellIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "celldblclick", "type" : "function", "desc" : "Fires when a cell is double clicked", "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "The raw click event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "columnmove", "type" : "function", "desc" : "Fires when the user moves a column", "sig" : "function (oldIndex, newIndex)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "oldIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "columnresize", "type" : "function", "desc" : "Fires when the user resizes a column", "sig" : "function (columnIndex, newSize)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "newSize", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "contextmenu", "type" : "function", "desc" : "The raw contextmenu event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dblclick", "type" : "function", "desc" : "The raw dblclick event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dragdrop", "type" : "function", "desc" : "Fires when dragged row(s) are dropped on a valid DD target", "sig" : "function (_self, dd, targetId, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dragenter", "type" : "function", "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged", "sig" : "function (_self, dd, targetId, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dragout", "type" : "function", "desc" : "Fires when the dragged row(s) leave another DD target while being dragged", "sig" : "function (_self, dd, targetId, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dragover", "type" : "function", "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.", "sig" : "function (_self, dd, targetId, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "targetId", + "type" : "String", + "desc" : "The target drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enddrag", "type" : "function", "desc" : "Fires when a drag operation is complete", "sig" : "function (_self, dd, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "headerclick", "type" : "function", "desc" : "Fires when a header is clicked", "sig" : "function (_self, columnIndex, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "headercontextmenu", "type" : "function", "desc" : "Fires when a header is right clicked", "sig" : "function (_self, columnIndex, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "headerdblclick", "type" : "function", "desc" : "Fires when a header cell is double clicked", "sig" : "function (_self, columnIndex, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "columnIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keydown", "type" : "function", "desc" : "The raw keydown event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "keypress", "type" : "function", "desc" : "The raw keypress event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mousedown", "type" : "function", "desc" : "The raw mousedown event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseout", "type" : "function", "desc" : "The raw mouseout event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseover", "type" : "function", "desc" : "The raw mouseover event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseup", "type" : "function", "desc" : "The raw mouseup event for the entire grid.", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "propertychange", "type" : "function", "desc" : "Fires after a property changes", "sig" : "function (grid, id, newval, oldval)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "grid", + "type" : "Roo.grid.PropertyGrid", + "desc" : "property grid? (check could be store)", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "Record Id", + "isOptional" : false + }, + { + "name" : "newval", + "type" : "String", + "desc" : "New Value", + "isOptional" : false + }, + { + "name" : "oldval", + "type" : "String", + "desc" : "Old Value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "render", "type" : "function", "desc" : "Fires when the grid is rendered", "sig" : "function (grid)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "grid", + "type" : "Grid", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rowclass", "type" : "function", "desc" : "Fires when a row is rendered, so you can change add a style to it.", "sig" : "function (gridview, rowcfg)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "gridview", + "type" : "GridView", + "desc" : "The grid view", + "isOptional" : false + }, + { + "name" : "rowcfg", + "type" : "Object", + "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rowclick", "type" : "function", "desc" : "Fires when a row is clicked", "sig" : "function (_self, rowIndex, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rowcontextmenu", "type" : "function", "desc" : "Fires when a row is right clicked", "sig" : "function (_self, rowIndex, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rowdblclick", "type" : "function", "desc" : "Fires when a row is double clicked", "sig" : "function (_self, rowIndex, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "startdrag", "type" : "function", "desc" : "Fires when row(s) start being dragged", "sig" : "function (_self, dd, e)\n{\n\n}", - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Grid", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "Roo.GridDD", + "desc" : "The drag drop object", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "validateedit", "type" : "function", "desc" : "Fires after a cell is edited, but before the value is set in the record. \nYou can use this to modify the value being set in the field, Return false\nto cancel the change. The edit event object has the following properties
\n", "sig" : "function (e)\n{\n\n}", - "memberOf" : "Roo.grid.EditorGrid" + "memberOf" : "Roo.grid.EditorGrid", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "e", + "type" : "Object", + "desc" : "An edit event (see above for description)", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -100192,7 +268686,31 @@ "desc" : "addColumns\nAdd's a column, default at the end..", "sig" : "(position, of)", "static" : false, - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "position", + "type" : "int", + "desc" : "to add (default end)", + "isOptional" : false + }, + { + "name" : "of", + "type" : "Array", + "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addEvents", @@ -100200,7 +268718,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -100208,7 +268744,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "autoSize", @@ -100216,7 +268788,18 @@ "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "capture", @@ -100224,7 +268807,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -100232,7 +268845,25 @@ "desc" : "Destroy this grid.", "sig" : "(removeEl)", "static" : false, - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "removeEl", + "type" : "Boolean", + "desc" : "True to remove the element", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -100240,7 +268871,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getColumnModel", @@ -100248,7 +268909,24 @@ "desc" : "Returns the grid's ColumnModel.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "ColumnModel", + "desc" : "" + } + ] }, { "name" : "getDataSource", @@ -100256,7 +268934,24 @@ "desc" : "Returns the grid's DataSource.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "DataSource", + "desc" : "" + } + ] }, { "name" : "getDragDropText", @@ -100264,7 +268959,24 @@ "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.grid.EditorGrid" + "memberOf" : "Roo.grid.EditorGrid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getGridEl", @@ -100272,7 +268984,24 @@ "desc" : "Returns the grid's underlying element.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Element", + "desc" : "The element" + } + ] }, { "name" : "getSelectionModel", @@ -100280,7 +269009,24 @@ "desc" : "Returns the grid's SelectionModel.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "SelectionModel", + "desc" : "" + } + ] }, { "name" : "getSource", @@ -100288,7 +269034,24 @@ "desc" : "Gets all the data from the grid.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "data data stored in grid" + } + ] }, { "name" : "getView", @@ -100296,7 +269059,24 @@ "desc" : "Returns the grid's GridView object.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "GridView", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -100304,7 +269084,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "on", @@ -100312,7 +269116,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -100320,7 +269160,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "reconfigure", @@ -100328,7 +269179,31 @@ "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.", "sig" : "(dataSource, The)", "static" : false, - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "dataSource", + "type" : "Roo.data.Store", + "desc" : "The new {@link Roo.data.Store} object", + "isOptional" : false + }, + { + "name" : "The", + "type" : "Roo.grid.ColumnModel", + "desc" : "new {@link Roo.grid.ColumnModel} object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "releaseCapture", @@ -100336,7 +269211,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -100344,7 +269237,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -100352,7 +269275,24 @@ "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.grid.Grid" + "memberOf" : "Roo.grid.Grid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.grid.Grid", + "desc" : "this" + } + ] }, { "name" : "setSource", @@ -100360,7 +269300,25 @@ "desc" : "Sets the data for the Grid\naccepts a Key => Value object of all the elements avaiable.", "sig" : "(data)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "data", + "type" : "Object", + "desc" : "to appear in grid.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "startEditing", @@ -100368,7 +269326,31 @@ "desc" : "Starts editing the specified for the specified row/column", "sig" : "(rowIndex, colIndex)", "static" : false, - "memberOf" : "Roo.grid.EditorGrid" + "memberOf" : "Roo.grid.EditorGrid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + }, + { + "name" : "colIndex", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "stopEditing", @@ -100376,7 +269358,18 @@ "desc" : "Stops any active editing", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.grid.EditorGrid" + "memberOf" : "Roo.grid.EditorGrid", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -100384,7 +269377,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -100409,35 +269432,130 @@ "type" : "function", "desc" : "Fires after the selection changes (eg. by key press or clicking)", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforerowselect", "type" : "function", "desc" : "Fires when a row is selected being selected, return false to cancel.", "sig" : "function (_self, rowIndex, keepExisting)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "The selected index", + "isOptional" : false + }, + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "False if other selections will be cleared", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rowdeselect", "type" : "function", "desc" : "Fires when a row is deselected.", "sig" : "function (_self, rowIndex)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "The selected index", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "rowselect", "type" : "function", "desc" : "Fires when a row is selected.", "sig" : "function (_self, rowIndex, r)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "The selected index", + "isOptional" : false + }, + { + "name" : "r", + "type" : "Roo.data.Record", + "desc" : "The record", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "selectionchange", "type" : "function", "desc" : "Fires when the selection changes", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -100447,7 +269565,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -100455,7 +269591,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -100463,7 +269635,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearSelections", @@ -100471,7 +269673,18 @@ "desc" : "Clears all selections.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "deselectRange", @@ -100479,7 +269692,31 @@ "desc" : "Deselects a range of rows. All rows in between startRow and endRow are also deselected.", "sig" : "(startRow, endRow)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "startRow", + "type" : "Number", + "desc" : "The index of the first row in the range", + "isOptional" : false + }, + { + "name" : "endRow", + "type" : "Number", + "desc" : "The index of the last row in the range", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "deselectRow", @@ -100487,7 +269724,25 @@ "desc" : "Deselects a row.", "sig" : "(row)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "row", + "type" : "Number", + "desc" : "The index of the row to deselect", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -100495,7 +269750,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getCount", @@ -100503,7 +269788,24 @@ "desc" : "Gets the number of selected rows.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] }, { "name" : "getSelected", @@ -100511,7 +269813,24 @@ "desc" : "Returns the first selected record.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Record", + "desc" : "" + } + ] }, { "name" : "getSelections", @@ -100519,7 +269838,24 @@ "desc" : "Returns the selected records", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "Array of selected records" + } + ] }, { "name" : "hasListener", @@ -100527,7 +269863,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hasSelection", @@ -100535,7 +269895,24 @@ "desc" : "Returns True if there is a selection.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isIdSelected", @@ -100543,7 +269920,31 @@ "desc" : "Returns True if the specified record id is selected.", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id of record to check", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isLocked", @@ -100551,7 +269952,24 @@ "desc" : "Returns true if the selections are locked.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.grid.AbstractSelectionModel" + "memberOf" : "Roo.grid.AbstractSelectionModel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isSelected", @@ -100559,7 +269977,31 @@ "desc" : "Returns True if the specified row is selected.", "sig" : "(record)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "record", + "type" : "Number/Record", + "desc" : "The record or index of the record to check", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "lock", @@ -100567,7 +270009,18 @@ "desc" : "Locks the selections.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.grid.AbstractSelectionModel" + "memberOf" : "Roo.grid.AbstractSelectionModel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -100575,7 +270028,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -100583,7 +270072,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -100591,7 +270091,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -100599,7 +270117,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "selectAll", @@ -100607,7 +270155,18 @@ "desc" : "Selects all rows.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "selectFirstRow", @@ -100615,7 +270174,18 @@ "desc" : "Selects the first row in the grid.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "selectLastRow", @@ -100623,7 +270193,25 @@ "desc" : "Select the last row.", "sig" : "(keepExisting)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) True to keep existing selections", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "selectNext", @@ -100631,7 +270219,25 @@ "desc" : "Selects the row immediately following the last selected row.", "sig" : "(keepExisting)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) True to keep existing selections", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "selectPrevious", @@ -100639,7 +270245,25 @@ "desc" : "Selects the row that precedes the last selected row.", "sig" : "(keepExisting)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) True to keep existing selections", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "selectRange", @@ -100647,7 +270271,37 @@ "desc" : "Selects a range of rows. All rows in between startRow and endRow are also selected.", "sig" : "(startRow, endRow, keepExisting)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "startRow", + "type" : "Number", + "desc" : "The index of the first row in the range", + "isOptional" : false + }, + { + "name" : "endRow", + "type" : "Number", + "desc" : "The index of the last row in the range", + "isOptional" : false + }, + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) True to retain existing selections", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "selectRecords", @@ -100655,7 +270309,31 @@ "desc" : "Select records.", "sig" : "(records, keepExisting)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "records", + "type" : "Array", + "desc" : "The records to select", + "isOptional" : false + }, + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) True to keep existing selections", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "selectRow", @@ -100663,7 +270341,31 @@ "desc" : "Selects a row.", "sig" : "(row, keepExisting)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "row", + "type" : "Number", + "desc" : "The index of the row to select", + "isOptional" : false + }, + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) True to keep existing selections", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "selectRows", @@ -100671,7 +270373,31 @@ "desc" : "Selects multiple rows.", "sig" : "(rows, keepExisting)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "rows", + "type" : "Array", + "desc" : "Array of the indexes of the row to select", + "isOptional" : false + }, + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) True to keep existing selections", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "un", @@ -100679,7 +270405,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "unlock", @@ -100687,7 +270443,18 @@ "desc" : "Unlocks the selections.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.grid.AbstractSelectionModel" + "memberOf" : "Roo.grid.AbstractSelectionModel", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -100708,7 +270475,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addInvalidHandleClass", @@ -100716,7 +270501,25 @@ "desc" : "Lets you specify a css class of elements that will not initiate a drag", "sig" : "(cssClass)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the elements you wish to ignore", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addInvalidHandleId", @@ -100724,7 +270527,25 @@ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the element id of the element you wish to ignore", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addInvalidHandleType", @@ -100732,7 +270553,25 @@ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", "sig" : "(tagName)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to exclude", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addListener", @@ -100740,7 +270579,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "addToGroup", @@ -100748,7 +270623,25 @@ "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", "sig" : "(sGroup)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "", + "desc" : "{string} the name of the group", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "alignElWithMouse", @@ -100756,7 +270649,37 @@ "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", "sig" : "(el, iPageX, iPageY)", "static" : false, - "memberOf" : "Roo.dd.DD" + "memberOf" : "Roo.dd.DD", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "HTMLElement", + "desc" : "the element to move", + "isOptional" : false + }, + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the mousedown or drag event", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the mousedown or drag event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "applyConfig", @@ -100764,7 +270687,18 @@ "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "autoOffset", @@ -100772,7 +270706,31 @@ "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked", "sig" : "(iPageX, iPageY)", "static" : false, - "memberOf" : "Roo.dd.DD" + "memberOf" : "Roo.dd.DD", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the click", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the click", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "cachePosition", @@ -100780,7 +270738,31 @@ "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.", "sig" : "(iPageX, iPageY)", "static" : false, - "memberOf" : "Roo.dd.DD" + "memberOf" : "Roo.dd.DD", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "", + "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "", + "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "capture", @@ -100788,7 +270770,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearConstraints", @@ -100796,7 +270808,18 @@ "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "clearTicks", @@ -100804,7 +270827,18 @@ "desc" : "Clears any tick interval defined for this instance", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "createFrame", @@ -100812,7 +270846,18 @@ "desc" : "Creates the proxy element if it does not yet exist", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DDProxy" + "memberOf" : "Roo.dd.DDProxy", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "endDrag", @@ -100820,7 +270865,25 @@ "desc" : "Fired when we are done dragging the object", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -100828,7 +270891,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getDragEl", @@ -100836,7 +270929,24 @@ "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] }, { "name" : "getEl", @@ -100844,7 +270954,24 @@ "desc" : "Returns a reference to the linked element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "HTMLElement", + "desc" : "the html element" + } + ] }, { "name" : "hasListener", @@ -100852,7 +270979,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "init", @@ -100860,7 +271011,37 @@ "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", "sig" : "(id, sGroup, config)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "initFrame", @@ -100868,7 +271049,18 @@ "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DDProxy" + "memberOf" : "Roo.dd.DDProxy", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "initTarget", @@ -100876,7 +271068,37 @@ "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", "sig" : "(id, sGroup, config)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the linked element", + "isOptional" : false + }, + { + "name" : "sGroup", + "type" : "String", + "desc" : "the group of related items", + "isOptional" : false + }, + { + "name" : "config", + "type" : "object", + "desc" : "configuration attributes", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "isLocked", @@ -100884,7 +271106,24 @@ "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this obj or all drag/drop is locked, else\nfalse" + } + ] }, { "name" : "isTarget", @@ -100892,7 +271131,18 @@ "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValidHandleChild", @@ -100900,7 +271150,31 @@ "desc" : "Checks the tag exclusion list to see if this click should be ignored", "sig" : "(node)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "HTMLElement", + "desc" : "the HTMLElement to evaluate", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "boolean", + "desc" : "true if this is a valid tag type, false if not" + } + ] }, { "name" : "lock", @@ -100908,7 +271182,18 @@ "desc" : "Lock this instance", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -100916,7 +271201,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "onAvailable", @@ -100924,7 +271245,18 @@ "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "onDrag", @@ -100932,7 +271264,25 @@ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragDrop", @@ -100940,7 +271290,31 @@ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragEnter", @@ -100948,7 +271322,31 @@ "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragOut", @@ -100956,7 +271354,31 @@ "desc" : "Abstract method called when we are no longer hovering over an element", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onDragOver", @@ -100964,7 +271386,31 @@ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", "sig" : "(e, id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousemove event", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String|DragDrop[]", + "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onInvalidDrop", @@ -100972,7 +271418,25 @@ "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onMouseDown", @@ -100980,7 +271444,25 @@ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mousedown event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "onMouseUp", @@ -100988,7 +271470,25 @@ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", "sig" : "(e)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "e", + "type" : "Event", + "desc" : "the mouseup event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "padding", @@ -100996,7 +271496,18 @@ "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "purgeListeners", @@ -101004,7 +271515,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -101012,7 +271534,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "removeFromGroup", @@ -101020,7 +271560,25 @@ "desc" : "Remove's this instance from the supplied interaction group", "sig" : "(sGroup)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "sGroup", + "type" : "string", + "desc" : "The group to drop", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleClass", @@ -101028,7 +271586,25 @@ "desc" : "Unsets an invalid css class", "sig" : "(cssClass)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cssClass", + "type" : "string", + "desc" : "the class of the element(s) you wish to\nre-enable", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleId", @@ -101036,7 +271612,25 @@ "desc" : "Unsets an invalid handle id", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "string", + "desc" : "the id of the element to re-enable", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeInvalidHandleType", @@ -101044,7 +271638,25 @@ "desc" : "Unsets an excluded tag name set by addInvalidHandleType", "sig" : "(tagName)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "tagName", + "type" : "string", + "desc" : "the type of element to unexclude", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeListener", @@ -101052,7 +271664,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "resetConstraints", @@ -101060,7 +271702,25 @@ "desc" : "resetConstraints must be called if you manually reposition a dd element.", "sig" : "(maintainOffset)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "maintainOffset", + "type" : "boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDelta", @@ -101068,7 +271728,31 @@ "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)", "sig" : "(iDeltaX, iDeltaY)", "static" : false, - "memberOf" : "Roo.dd.DD" + "memberOf" : "Roo.dd.DD", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iDeltaX", + "type" : "int", + "desc" : "the distance from the left", + "isOptional" : false + }, + { + "name" : "iDeltaY", + "type" : "int", + "desc" : "the distance from the top", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDragElId", @@ -101076,7 +271760,25 @@ "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDragElPos", @@ -101084,7 +271786,31 @@ "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", "sig" : "(iPageX, iPageY)", "static" : false, - "memberOf" : "Roo.dd.DD" + "memberOf" : "Roo.dd.DD", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iPageX", + "type" : "int", + "desc" : "the X coordinate of the mousedown or drag event", + "isOptional" : false + }, + { + "name" : "iPageY", + "type" : "int", + "desc" : "the Y coordinate of the mousedown or drag event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setHandleElId", @@ -101092,7 +271818,25 @@ "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "{string} the id of the element that will be used to\ninitiate the drag.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setInitPosition", @@ -101100,7 +271844,31 @@ "desc" : "Stores the initial placement of the linked element.", "sig" : "(diffX, diffY)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "diffX", + "type" : "int", + "desc" : "the X offset, default 0", + "isOptional" : false + }, + { + "name" : "diffY", + "type" : "int", + "desc" : "the Y offset, default 0", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setOuterHandleElId", @@ -101108,7 +271876,25 @@ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "", + "desc" : "the id of the element that will be used to initiate the drag", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setPadding", @@ -101116,7 +271902,43 @@ "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", "sig" : "(iTop, iRight, iBot, iLeft)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iTop", + "type" : "int", + "desc" : "Top pad", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "Right pad", + "isOptional" : false + }, + { + "name" : "iBot", + "type" : "int", + "desc" : "Bot pad", + "isOptional" : false + }, + { + "name" : "iLeft", + "type" : "int", + "desc" : "Left pad", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setXConstraint", @@ -101124,7 +271946,37 @@ "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", "sig" : "(iLeft, iRight, iTickSize)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iLeft", + "type" : "int", + "desc" : "the number of pixels the element can move to the left", + "isOptional" : false + }, + { + "name" : "iRight", + "type" : "int", + "desc" : "the number of pixels the element can move to the\nright", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setYConstraint", @@ -101132,7 +271984,37 @@ "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", "sig" : "(iUp, iDown, iTickSize)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "iUp", + "type" : "int", + "desc" : "the number of pixels the element can move up", + "isOptional" : false + }, + { + "name" : "iDown", + "type" : "int", + "desc" : "the number of pixels the element can move down", + "isOptional" : false + }, + { + "name" : "iTickSize", + "type" : "int", + "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "startDrag", @@ -101140,7 +272022,31 @@ "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", "sig" : "(X, Y)", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "X", + "type" : "int", + "desc" : "click location", + "isOptional" : false + }, + { + "name" : "Y", + "type" : "int", + "desc" : "click location", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "toString", @@ -101148,7 +272054,24 @@ "desc" : "toString method", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "string", + "desc" : "string representation of the dd obj" + } + ] }, { "name" : "un", @@ -101156,7 +272079,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "unlock", @@ -101164,7 +272117,18 @@ "desc" : "Unlock this instace", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "unreg", @@ -101172,7 +272136,18 @@ "desc" : "Remove all drag and drop hooks for this element", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.dd.DragDrop" + "memberOf" : "Roo.dd.DragDrop", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -101191,7 +272166,18 @@ "desc" : "", "sig" : "()\n{\n\n}", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -101259,11 +272245,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "hideOnClick", @@ -101284,91 +272266,266 @@ "type" : "function", "desc" : "Fires when this item is activated", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.menu.BaseItem" + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fires when this item is clicked", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.menu.BaseItem" + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "deactivate", "type" : "function", "desc" : "Fires when this item is deactivated", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.menu.BaseItem" + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -101378,7 +272535,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -101386,7 +272561,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -101394,7 +272605,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -101402,7 +272643,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -101410,7 +272662,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -101418,7 +272687,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -101426,7 +272712,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -101434,7 +272750,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getEl", @@ -101442,7 +272782,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -101450,7 +272807,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -101458,7 +272832,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -101466,7 +272864,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isVisible", @@ -101474,7 +272889,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -101482,7 +272908,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -101490,7 +272952,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -101498,7 +272971,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -101506,7 +272997,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -101514,7 +273035,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -101522,7 +273061,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisible", @@ -101530,7 +273087,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -101538,7 +273119,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "un", @@ -101546,7 +273144,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -101604,11 +273232,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "hideOnClick", @@ -101629,91 +273253,266 @@ "type" : "function", "desc" : "Fires when this item is activated", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fires when this item is clicked", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "deactivate", "type" : "function", "desc" : "Fires when this item is deactivated", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -101723,7 +273522,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -101731,7 +273548,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -101739,7 +273592,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -101747,7 +273630,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -101755,7 +273649,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -101763,7 +273674,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -101771,7 +273699,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -101779,7 +273737,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getEl", @@ -101787,7 +273769,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -101795,7 +273794,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -101803,7 +273819,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -101811,7 +273851,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isVisible", @@ -101819,7 +273876,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -101827,7 +273895,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -101835,7 +273939,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -101843,7 +273958,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -101851,7 +273984,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -101859,7 +274022,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -101867,7 +274048,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisible", @@ -101875,7 +274074,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -101883,7 +274106,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "un", @@ -101891,7 +274131,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -101973,11 +274243,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "hideOnClick", @@ -102003,6 +274269,12 @@ "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", "memberOf" : "Roo.util.Observable" }, + { + "name" : "menu", + "type" : "Roo.menu.Menu", + "desc" : "A Sub menu", + "memberOf" : "Roo.menu.Item" + }, { "name" : "showDelay", "type" : "Number", @@ -102022,105 +274294,318 @@ "type" : "function", "desc" : "Fires when this item is activated", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.menu.BaseItem" + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforecheckchange", "type" : "function", "desc" : "Fires before the checked value is set, providing an opportunity to cancel if needed", "sig" : "function (_self, checked)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.CheckItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "The new checked value that will be set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "checkchange", "type" : "function", "desc" : "Fires after the checked value has been set", "sig" : "function (_self, checked)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.CheckItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "The checked value that was set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fires when this item is clicked", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.menu.BaseItem" + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "deactivate", "type" : "function", "desc" : "Fires when this item is deactivated", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.menu.BaseItem" + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -102130,7 +274615,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -102138,7 +274641,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -102146,7 +274685,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -102154,7 +274723,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -102162,7 +274742,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -102170,7 +274767,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -102178,7 +274792,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -102186,7 +274830,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getEl", @@ -102194,7 +274862,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -102202,7 +274887,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -102210,7 +274912,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -102218,7 +274944,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isVisible", @@ -102226,7 +274969,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -102234,7 +274988,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -102242,7 +275032,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -102250,7 +275051,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -102258,7 +275077,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -102266,7 +275115,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setChecked", @@ -102274,7 +275141,31 @@ "desc" : "Set the checked state of this item", "sig" : "(checked, suppressEvent)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "checked", + "type" : "Boolean", + "desc" : "The new checked value", + "isOptional" : false + }, + { + "name" : "suppressEvent", + "type" : "Boolean", + "desc" : "(optional) True to prevent the checkchange event from firing (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setDisabled", @@ -102282,7 +275173,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setText", @@ -102290,7 +275199,31 @@ "desc" : "Sets the text to display in this menu item", "sig" : "(text, isHTML)", "static" : false, - "memberOf" : "Roo.menu.Item" + "memberOf" : "Roo.menu.Item", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The text to display", + "isOptional" : false + }, + { + "name" : "isHTML", + "type" : "Boolean", + "desc" : "true to indicate text is pure html.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -102298,7 +275231,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -102306,7 +275263,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "un", @@ -102314,7 +275288,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -102372,11 +275376,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "hideOnClick", @@ -102397,91 +275397,266 @@ "type" : "function", "desc" : "Fires when this item is activated", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.menu.BaseItem" + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fires when this item is clicked", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.menu.BaseItem" + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "deactivate", "type" : "function", "desc" : "Fires when this item is deactivated", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.menu.BaseItem" + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -102491,7 +275666,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -102499,7 +275692,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -102507,7 +275736,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -102515,7 +275774,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -102523,7 +275793,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -102531,7 +275818,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -102539,7 +275843,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -102547,7 +275881,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getEl", @@ -102555,7 +275913,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -102563,7 +275938,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -102571,7 +275963,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -102579,7 +275995,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isVisible", @@ -102587,7 +276020,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -102595,7 +276039,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -102603,7 +276083,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -102611,7 +276102,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -102619,7 +276128,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -102627,7 +276166,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -102635,7 +276192,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisible", @@ -102643,7 +276218,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -102651,7 +276250,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "un", @@ -102659,7 +276275,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -102714,63 +276360,228 @@ "type" : "function", "desc" : "Fires before this menu is hidden", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeshow", "type" : "function", "desc" : "Fires before this menu is displayed", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)", "sig" : "function (_self, menuItem, e)\n{\n\n}", - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after this menu is hidden", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "itemclick", "type" : "function", "desc" : "Fires when a menu item contained in this menu is clicked", "sig" : "function (baseItem, e)\n{\n\n}", - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "baseItem", + "type" : "Roo.menu.BaseItem", + "desc" : "The BaseItem that was clicked", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseout", "type" : "function", "desc" : "Fires when the mouse exits this menu", "sig" : "function (_self, e, menuItem)\n{\n\n}", - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseover", "type" : "function", "desc" : "Fires when the mouse is hovering over this menu", "sig" : "function (_self, e, menuItem)\n{\n\n}", - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "select", "type" : "function", "desc" : "", "sig" : "function (palette, color)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "palette", + "type" : "ColorPalette", + "desc" : "", + "isOptional" : false + }, + { + "name" : "color", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after this menu is displayed", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -102780,7 +276591,31 @@ "desc" : "Addds one or more items of any type supported by the Menu class, or that can be converted into menu items.\nAny of the following are valid:\n\nUsage:\n
\n// Create the menu\nvar menu = new Roo.menu.Menu();\n\n// Create a menu item to add by reference\nvar menuItem = new Roo.menu.Item({ text: 'New Item!' });\n\n// Add a bunch of items at once using different methods.\n// Only the last item added will be returned.\nvar item = menu.add(\n    menuItem,                // add existing item by ref\n    'Dynamic Item',          // new TextItem\n    '-',                     // new separator\n    { text: 'Config Item' }  // new item by config\n);\n
", "sig" : "(args)", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "args", + "type" : "Mixed", + "desc" : "One or more menu items, menu item configs or other objects that can be converted to menu items", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added, or the last one if multiple items were added" + } + ] }, { "name" : "addElement", @@ -102788,7 +276623,31 @@ "desc" : "Adds an {@link Roo.Element} object to the menu", "sig" : "(el)", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element or DOM node to add, or its id", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] }, { "name" : "addEvents", @@ -102796,7 +276655,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addItem", @@ -102804,7 +276681,31 @@ "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu", "sig" : "(item)", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "item", + "type" : "Roo.menu.Item", + "desc" : "The menu item to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] }, { "name" : "addListener", @@ -102812,7 +276713,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "addMenuItem", @@ -102820,7 +276757,31 @@ "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu", "sig" : "(config)", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "A MenuItem config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] }, { "name" : "addSeparator", @@ -102828,7 +276789,24 @@ "desc" : "Adds a separator bar to the menu", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] }, { "name" : "addText", @@ -102836,7 +276814,31 @@ "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu", "sig" : "(text)", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The text to display in the menu item", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] }, { "name" : "capture", @@ -102844,7 +276846,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "fireEvent", @@ -102852,7 +276884,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getEl", @@ -102860,7 +276922,24 @@ "desc" : "Returns this menu's underlying {@link Roo.Element} object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] }, { "name" : "hasListener", @@ -102868,7 +276947,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -102876,7 +276979,25 @@ "desc" : "Hides this menu and optionally all parent menus", "sig" : "(deep)", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "insert", @@ -102884,7 +277005,37 @@ "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index", "sig" : "(index, item)", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index in the menu's list of current items where the new item should be inserted", + "isOptional" : false + }, + { + "name" : "item", + "type" : "Roo.menu.Item", + "desc" : "The menu item to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] }, { "name" : "isVisible", @@ -102892,7 +277043,18 @@ "desc" : "Read-only. Returns true if the menu is currently displayed, else false.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -102900,7 +277062,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -102908,7 +277106,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -102916,7 +277125,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "remove", @@ -102924,7 +277151,25 @@ "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object", "sig" : "(item)", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "item", + "type" : "Roo.menu.Item", + "desc" : "The menu item to remove", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeAll", @@ -102932,7 +277177,18 @@ "desc" : "Removes and destroys all items in the menu", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "removeListener", @@ -102940,7 +277196,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "show", @@ -102948,7 +277234,37 @@ "desc" : "Displays this menu relative to another element", "sig" : "(element, position, parentMenu)", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "element", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element to align to", + "isOptional" : false + }, + { + "name" : "position", + "type" : "String", + "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)", + "isOptional" : false + }, + { + "name" : "parentMenu", + "type" : "Roo.menu.Menu", + "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "showAt", @@ -102956,7 +277272,31 @@ "desc" : "Displays this menu at a specific xy position", "sig" : "(xyPosition, parentMenu)", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "xyPosition", + "type" : "Array", + "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)", + "isOptional" : false + }, + { + "name" : "parentMenu", + "type" : "Roo.menu.Menu", + "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "un", @@ -102964,7 +277304,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -103022,11 +277392,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "hideOnClick", @@ -103047,91 +277413,266 @@ "type" : "function", "desc" : "Fires when this item is activated", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.menu.BaseItem" + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fires when this item is clicked", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.menu.BaseItem" + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "deactivate", "type" : "function", "desc" : "Fires when this item is deactivated", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.menu.BaseItem" + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -103141,7 +277682,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -103149,7 +277708,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -103157,7 +277752,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -103165,7 +277790,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -103173,7 +277809,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -103181,7 +277834,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -103189,7 +277859,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -103197,7 +277897,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getEl", @@ -103205,7 +277929,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -103213,7 +277954,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -103221,7 +277979,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -103229,7 +278011,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isVisible", @@ -103237,7 +278036,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -103245,7 +278055,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -103253,7 +278099,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -103261,7 +278118,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -103269,7 +278144,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -103277,7 +278182,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -103285,7 +278208,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisible", @@ -103293,7 +278234,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -103301,7 +278266,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "un", @@ -103309,7 +278291,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -103364,63 +278376,228 @@ "type" : "function", "desc" : "Fires before this menu is hidden", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeshow", "type" : "function", "desc" : "Fires before this menu is displayed", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)", "sig" : "function (_self, menuItem, e)\n{\n\n}", - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after this menu is hidden", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "itemclick", "type" : "function", "desc" : "Fires when a menu item contained in this menu is clicked", "sig" : "function (baseItem, e)\n{\n\n}", - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "baseItem", + "type" : "Roo.menu.BaseItem", + "desc" : "The BaseItem that was clicked", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseout", "type" : "function", "desc" : "Fires when the mouse exits this menu", "sig" : "function (_self, e, menuItem)\n{\n\n}", - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseover", "type" : "function", "desc" : "Fires when the mouse is hovering over this menu", "sig" : "function (_self, e, menuItem)\n{\n\n}", - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "select", "type" : "function", "desc" : "", "sig" : "function (picker, date)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "picker", + "type" : "DatePicker", + "desc" : "", + "isOptional" : false + }, + { + "name" : "date", + "type" : "Date", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after this menu is displayed", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -103430,7 +278607,31 @@ "desc" : "Addds one or more items of any type supported by the Menu class, or that can be converted into menu items.\nAny of the following are valid:\n\nUsage:\n
\n// Create the menu\nvar menu = new Roo.menu.Menu();\n\n// Create a menu item to add by reference\nvar menuItem = new Roo.menu.Item({ text: 'New Item!' });\n\n// Add a bunch of items at once using different methods.\n// Only the last item added will be returned.\nvar item = menu.add(\n    menuItem,                // add existing item by ref\n    'Dynamic Item',          // new TextItem\n    '-',                     // new separator\n    { text: 'Config Item' }  // new item by config\n);\n
", "sig" : "(args)", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "args", + "type" : "Mixed", + "desc" : "One or more menu items, menu item configs or other objects that can be converted to menu items", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added, or the last one if multiple items were added" + } + ] }, { "name" : "addElement", @@ -103438,7 +278639,31 @@ "desc" : "Adds an {@link Roo.Element} object to the menu", "sig" : "(el)", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element or DOM node to add, or its id", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] }, { "name" : "addEvents", @@ -103446,7 +278671,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addItem", @@ -103454,7 +278697,31 @@ "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu", "sig" : "(item)", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "item", + "type" : "Roo.menu.Item", + "desc" : "The menu item to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] }, { "name" : "addListener", @@ -103462,7 +278729,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "addMenuItem", @@ -103470,7 +278773,31 @@ "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu", "sig" : "(config)", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "A MenuItem config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] }, { "name" : "addSeparator", @@ -103478,7 +278805,24 @@ "desc" : "Adds a separator bar to the menu", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] }, { "name" : "addText", @@ -103486,7 +278830,31 @@ "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu", "sig" : "(text)", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The text to display in the menu item", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] }, { "name" : "capture", @@ -103494,7 +278862,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "fireEvent", @@ -103502,7 +278900,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getEl", @@ -103510,7 +278938,24 @@ "desc" : "Returns this menu's underlying {@link Roo.Element} object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] }, { "name" : "hasListener", @@ -103518,7 +278963,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -103526,7 +278995,25 @@ "desc" : "Hides this menu and optionally all parent menus", "sig" : "(deep)", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "insert", @@ -103534,7 +279021,37 @@ "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index", "sig" : "(index, item)", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index in the menu's list of current items where the new item should be inserted", + "isOptional" : false + }, + { + "name" : "item", + "type" : "Roo.menu.Item", + "desc" : "The menu item to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] }, { "name" : "isVisible", @@ -103542,7 +279059,18 @@ "desc" : "Read-only. Returns true if the menu is currently displayed, else false.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -103550,7 +279078,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -103558,7 +279122,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -103566,7 +279141,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "remove", @@ -103574,7 +279167,25 @@ "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object", "sig" : "(item)", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "item", + "type" : "Roo.menu.Item", + "desc" : "The menu item to remove", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeAll", @@ -103582,7 +279193,18 @@ "desc" : "Removes and destroys all items in the menu", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "removeListener", @@ -103590,7 +279212,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "show", @@ -103598,7 +279250,37 @@ "desc" : "Displays this menu relative to another element", "sig" : "(element, position, parentMenu)", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "element", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element to align to", + "isOptional" : false + }, + { + "name" : "position", + "type" : "String", + "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)", + "isOptional" : false + }, + { + "name" : "parentMenu", + "type" : "Roo.menu.Menu", + "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "showAt", @@ -103606,7 +279288,31 @@ "desc" : "Displays this menu at a specific xy position", "sig" : "(xyPosition, parentMenu)", "static" : false, - "memberOf" : "Roo.menu.Menu" + "memberOf" : "Roo.menu.Menu", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "xyPosition", + "type" : "Array", + "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)", + "isOptional" : false + }, + { + "name" : "parentMenu", + "type" : "Roo.menu.Menu", + "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "un", @@ -103614,7 +279320,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -103678,11 +279414,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "hideOnClick", @@ -103708,6 +279440,12 @@ "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", "memberOf" : "Roo.util.Observable" }, + { + "name" : "menu", + "type" : "Roo.menu.Menu", + "desc" : "A Sub menu", + "memberOf" : "" + }, { "name" : "showDelay", "type" : "Number", @@ -103727,91 +279465,266 @@ "type" : "function", "desc" : "Fires when this item is activated", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.menu.BaseItem" + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fires when this item is clicked", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.menu.BaseItem" + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "deactivate", "type" : "function", "desc" : "Fires when this item is deactivated", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.menu.BaseItem" + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -103821,7 +279734,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -103829,7 +279760,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -103837,7 +279804,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -103845,7 +279842,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -103853,7 +279861,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -103861,7 +279886,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -103869,7 +279911,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -103877,7 +279949,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getEl", @@ -103885,7 +279981,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -103893,7 +280006,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -103901,7 +280031,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -103909,7 +280063,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isVisible", @@ -103917,7 +280088,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -103925,7 +280107,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -103933,7 +280151,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -103941,7 +280170,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -103949,7 +280196,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -103957,7 +280234,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -103965,7 +280260,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setText", @@ -103973,7 +280286,31 @@ "desc" : "Sets the text to display in this menu item", "sig" : "(text, isHTML)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The text to display", + "isOptional" : false + }, + { + "name" : "isHTML", + "type" : "Boolean", + "desc" : "true to indicate text is pure html.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -103981,7 +280318,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -103989,7 +280350,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "un", @@ -103997,7 +280375,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -104052,56 +280460,202 @@ "type" : "function", "desc" : "Fires before this menu is hidden", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeshow", "type" : "function", "desc" : "Fires before this menu is displayed", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)", "sig" : "function (_self, menuItem, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hide", "type" : "function", "desc" : "Fires after this menu is hidden", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "itemclick", "type" : "function", "desc" : "Fires when a menu item contained in this menu is clicked", "sig" : "function (baseItem, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "baseItem", + "type" : "Roo.menu.BaseItem", + "desc" : "The BaseItem that was clicked", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseout", "type" : "function", "desc" : "Fires when the mouse exits this menu", "sig" : "function (_self, e, menuItem)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseover", "type" : "function", "desc" : "Fires when the mouse is hovering over this menu", "sig" : "function (_self, e, menuItem)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + }, + { + "name" : "menuItem", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was clicked", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "show", "type" : "function", "desc" : "Fires after this menu is displayed", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.Menu", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -104111,7 +280665,31 @@ "desc" : "Addds one or more items of any type supported by the Menu class, or that can be converted into menu items.\nAny of the following are valid:\n\nUsage:\n
\n// Create the menu\nvar menu = new Roo.menu.Menu();\n\n// Create a menu item to add by reference\nvar menuItem = new Roo.menu.Item({ text: 'New Item!' });\n\n// Add a bunch of items at once using different methods.\n// Only the last item added will be returned.\nvar item = menu.add(\n    menuItem,                // add existing item by ref\n    'Dynamic Item',          // new TextItem\n    '-',                     // new separator\n    { text: 'Config Item' }  // new item by config\n);\n
", "sig" : "(args)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "args", + "type" : "Mixed", + "desc" : "One or more menu items, menu item configs or other objects that can be converted to menu items", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added, or the last one if multiple items were added" + } + ] }, { "name" : "addElement", @@ -104119,7 +280697,31 @@ "desc" : "Adds an {@link Roo.Element} object to the menu", "sig" : "(el)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element or DOM node to add, or its id", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] }, { "name" : "addEvents", @@ -104127,7 +280729,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addItem", @@ -104135,7 +280755,31 @@ "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu", "sig" : "(item)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "item", + "type" : "Roo.menu.Item", + "desc" : "The menu item to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] }, { "name" : "addListener", @@ -104143,7 +280787,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "addMenuItem", @@ -104151,7 +280831,31 @@ "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu", "sig" : "(config)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "config", + "type" : "Object", + "desc" : "A MenuItem config object", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] }, { "name" : "addSeparator", @@ -104159,7 +280863,24 @@ "desc" : "Adds a separator bar to the menu", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] }, { "name" : "addText", @@ -104167,7 +280888,31 @@ "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu", "sig" : "(text)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "The text to display in the menu item", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] }, { "name" : "capture", @@ -104175,7 +280920,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "fireEvent", @@ -104183,7 +280958,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getEl", @@ -104191,7 +280996,24 @@ "desc" : "Returns this menu's underlying {@link Roo.Element} object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Element", + "desc" : "The element" + } + ] }, { "name" : "hasListener", @@ -104199,7 +281021,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -104207,7 +281053,25 @@ "desc" : "Hides this menu and optionally all parent menus", "sig" : "(deep)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "insert", @@ -104215,7 +281079,37 @@ "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index", "sig" : "(index, item)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index in the menu's list of current items where the new item should be inserted", + "isOptional" : false + }, + { + "name" : "item", + "type" : "Roo.menu.Item", + "desc" : "The menu item to add", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.menu.Item", + "desc" : "The menu item that was added" + } + ] }, { "name" : "isVisible", @@ -104223,7 +281117,18 @@ "desc" : "Read-only. Returns true if the menu is currently displayed, else false.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -104231,7 +281136,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -104239,7 +281180,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -104247,7 +281199,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "remove", @@ -104255,7 +281225,25 @@ "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object", "sig" : "(item)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "item", + "type" : "Roo.menu.Item", + "desc" : "The menu item to remove", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeAll", @@ -104263,7 +281251,18 @@ "desc" : "Removes and destroys all items in the menu", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "removeListener", @@ -104271,7 +281270,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "show", @@ -104279,7 +281308,37 @@ "desc" : "Displays this menu relative to another element", "sig" : "(element, position, parentMenu)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "element", + "type" : "String/HTMLElement/Roo.Element", + "desc" : "The element to align to", + "isOptional" : false + }, + { + "name" : "position", + "type" : "String", + "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)", + "isOptional" : false + }, + { + "name" : "parentMenu", + "type" : "Roo.menu.Menu", + "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "showAt", @@ -104287,7 +281346,31 @@ "desc" : "Displays this menu at a specific xy position", "sig" : "(xyPosition, parentMenu)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "xyPosition", + "type" : "Array", + "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)", + "isOptional" : false + }, + { + "name" : "parentMenu", + "type" : "Roo.menu.Menu", + "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "un", @@ -104295,7 +281378,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -104309,7 +281422,25 @@ "desc" : "Returns a {@link Roo.menu.Menu} object", "sig" : "(menu)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "menu", + "type" : "String/Object", + "desc" : "The string menu id, an existing menu object reference, or a Menu config that will\nbe used to generate and return a new Menu instance.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "hideAll", @@ -104317,7 +281448,18 @@ "desc" : "Hides all menus that are currently visible", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -104375,11 +281517,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "hideOnClick", @@ -104406,91 +281544,266 @@ "type" : "function", "desc" : "Fires when this item is activated", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.menu.BaseItem" + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fires when this item is clicked", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.menu.BaseItem" + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "deactivate", "type" : "function", "desc" : "Fires when this item is deactivated", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.menu.BaseItem" + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -104500,7 +281813,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -104508,7 +281839,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -104516,7 +281883,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -104524,7 +281921,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -104532,7 +281940,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -104540,7 +281965,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -104548,7 +281990,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -104556,7 +282028,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getEl", @@ -104564,7 +282060,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -104572,7 +282085,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -104580,7 +282110,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -104588,7 +282142,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isVisible", @@ -104596,7 +282167,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -104604,7 +282186,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -104612,7 +282230,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -104620,7 +282249,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -104628,7 +282275,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -104636,7 +282313,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -104644,7 +282339,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisible", @@ -104652,7 +282365,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -104660,7 +282397,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "un", @@ -104668,7 +282422,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -104726,11 +282510,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "hideOnClick", @@ -104763,91 +282543,266 @@ "type" : "function", "desc" : "Fires when this item is activated", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.menu.BaseItem" + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fires when this item is clicked", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.menu.BaseItem" + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "deactivate", "type" : "function", "desc" : "Fires when this item is deactivated", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.menu.BaseItem" + "memberOf" : "Roo.menu.BaseItem", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.menu.BaseItem", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -104857,7 +282812,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -104865,7 +282838,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -104873,7 +282882,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "destroy", @@ -104881,7 +282920,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -104889,7 +282939,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -104897,7 +282964,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -104905,7 +282989,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -104913,7 +283027,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getEl", @@ -104921,7 +283059,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -104929,7 +283084,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -104937,7 +283109,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -104945,7 +283141,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isVisible", @@ -104953,7 +283166,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -104961,7 +283185,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -104969,7 +283229,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -104977,7 +283248,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -104985,7 +283274,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -104993,7 +283312,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -105001,7 +283338,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setVisible", @@ -105009,7 +283364,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -105017,7 +283396,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "un", @@ -105025,7 +283421,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -105067,7 +283493,32 @@ "type" : "function", "desc" : "Fires when a state change occurs.", "sig" : "function (_self, key, value)\n{\n\n}", - "memberOf" : "Roo.state.Provider" + "memberOf" : "Roo.state.Provider", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Provider", + "desc" : "This state provider", + "isOptional" : false + }, + { + "name" : "key", + "type" : "String", + "desc" : "The state key which was changed", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String", + "desc" : "The encoded value for the state", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -105077,7 +283528,25 @@ "desc" : "Clears a value from the state", "sig" : "(name)", "static" : false, - "memberOf" : "Roo.state.Provider" + "memberOf" : "Roo.state.Provider", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "name", + "type" : "String", + "desc" : "The key name", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "decodeValue", @@ -105085,7 +283554,31 @@ "desc" : "Decodes a string previously encoded with {@link #encodeValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.state.Provider" + "memberOf" : "Roo.state.Provider", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The value to decode", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "The decoded value" + } + ] }, { "name" : "encodeValue", @@ -105093,7 +283586,31 @@ "desc" : "Encodes a value including type information. Decode with {@link #decodeValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.state.Provider" + "memberOf" : "Roo.state.Provider", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to encode", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The encoded value" + } + ] }, { "name" : "get", @@ -105101,7 +283618,37 @@ "desc" : "Returns the current value for a key", "sig" : "(name, defaultValue)", "static" : false, - "memberOf" : "Roo.state.Provider" + "memberOf" : "Roo.state.Provider", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "name", + "type" : "String", + "desc" : "The key name", + "isOptional" : false + }, + { + "name" : "defaultValue", + "type" : "Mixed", + "desc" : "A default value to return if the key's value is not found", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "The state data" + } + ] }, { "name" : "set", @@ -105109,7 +283656,31 @@ "desc" : "Sets the value for a key", "sig" : "(name, value)", "static" : false, - "memberOf" : "Roo.state.Provider" + "memberOf" : "Roo.state.Provider", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "name", + "type" : "String", + "desc" : "The key name", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -105123,7 +283694,25 @@ "desc" : "Clears a value from the state", "sig" : "(name)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "name", + "type" : "String", + "desc" : "The key name", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "get", @@ -105131,7 +283720,37 @@ "desc" : "Returns the current value for a key", "sig" : "(name, defaultValue)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "name", + "type" : "String", + "desc" : "The key name", + "isOptional" : false + }, + { + "name" : "defaultValue", + "type" : "Mixed", + "desc" : "The default value to return if the key lookup does not match", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "The state data" + } + ] }, { "name" : "getProvider", @@ -105139,7 +283758,24 @@ "desc" : "Gets the currently configured state provider", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Provider", + "desc" : "The state provider" + } + ] }, { "name" : "set", @@ -105147,7 +283783,31 @@ "desc" : "Sets the value for a key", "sig" : "(name, value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "name", + "type" : "String", + "desc" : "The key name", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The state data", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setProvider", @@ -105155,7 +283815,25 @@ "desc" : "Configures the default state provider for your application", "sig" : "(stateProvider)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "stateProvider", + "type" : "Provider", + "desc" : "The state provider to set", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -105167,7 +283845,32 @@ "type" : "function", "desc" : "Fires when a state change occurs.", "sig" : "function (_self, key, value)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Provider", + "desc" : "This state provider", + "isOptional" : false + }, + { + "name" : "key", + "type" : "String", + "desc" : "The state key which was changed", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String", + "desc" : "The encoded value for the state", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -105177,7 +283880,25 @@ "desc" : "Clears a value from the state", "sig" : "(name)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "name", + "type" : "String", + "desc" : "The key name", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "decodeValue", @@ -105185,7 +283906,31 @@ "desc" : "Decodes a string previously encoded with {@link #encodeValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The value to decode", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "The decoded value" + } + ] }, { "name" : "encodeValue", @@ -105193,7 +283938,31 @@ "desc" : "Encodes a value including type information. Decode with {@link #decodeValue}.", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to encode", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The encoded value" + } + ] }, { "name" : "get", @@ -105201,7 +283970,37 @@ "desc" : "Returns the current value for a key", "sig" : "(name, defaultValue)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "name", + "type" : "String", + "desc" : "The key name", + "isOptional" : false + }, + { + "name" : "defaultValue", + "type" : "Mixed", + "desc" : "A default value to return if the key's value is not found", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "The state data" + } + ] }, { "name" : "set", @@ -105209,7 +284008,31 @@ "desc" : "Sets the value for a key", "sig" : "(name, value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "name", + "type" : "String", + "desc" : "The key name", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to set", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -105341,154 +284164,650 @@ "type" : "function", "desc" : "Fires when a new child node is appended", "sig" : "function (tree, _self, node, index)\n{\n\n}", - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The newly appended node", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the newly appended node", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeappend", "type" : "function", "desc" : "Fires before a new child is appended, return false to cancel the append.", "sig" : "function (tree, _self, node)\n{\n\n}", - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be appended", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforechildrenrendered", "type" : "function", "desc" : "Fires right before the child nodes for this node are rendered", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeclick", "type" : "function", "desc" : "Fires before click processing. Return false to cancel the default action.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforecollapse", "type" : "function", "desc" : "Fires before this node is collapsed, return false to cancel.", "sig" : "function (_self, deep, anim)\n{\n\n}", - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "deep", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + }, + { + "name" : "anim", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeexpand", "type" : "function", "desc" : "Fires before this node is expanded, return false to cancel.", "sig" : "function (_self, deep, anim)\n{\n\n}", - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "deep", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + }, + { + "name" : "anim", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeinsert", "type" : "function", "desc" : "Fires before a new child is inserted, return false to cancel the insert.", "sig" : "function (tree, _self, node, refNode)\n{\n\n}", - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be inserted", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The child node the node is being inserted before", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeload", "type" : "function", "desc" : "Fires before this node is loaded, return false to cancel", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforemove", "type" : "function", "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.", "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}", - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "oldParent", + "type" : "Node", + "desc" : "The parent of this node", + "isOptional" : false + }, + { + "name" : "newParent", + "type" : "Node", + "desc" : "The new parent this node is moving to", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index it is being moved to", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeremove", "type" : "function", "desc" : "Fires before a child is removed, return false to cancel the remove.", "sig" : "function (tree, _self, node)\n{\n\n}", - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be removed", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "checkchange", "type" : "function", "desc" : "Fires when a node with a checkbox's checked property changes", "sig" : "function (_self, checked)\n{\n\n}", - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fires when this node is clicked", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "collapse", "type" : "function", "desc" : "Fires when this node is collapsed", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "contextmenu", "type" : "function", "desc" : "Fires when this node is right clicked", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dblclick", "type" : "function", "desc" : "Fires when this node is double clicked", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "disabledchange", "type" : "function", "desc" : "Fires when the disabled status of this node changes", "sig" : "function (_self, disabled)\n{\n\n}", - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "expand", "type" : "function", "desc" : "Fires when this node is expanded", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "insert", "type" : "function", "desc" : "Fires when a new child node is inserted.", "sig" : "function (tree, _self, node, refNode)\n{\n\n}", - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node inserted", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The child node the node was inserted before", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "load", "type" : "function", "desc" : "Fires when this node is loaded", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires when this node is moved to a new location in the tree", "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}", - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "oldParent", + "type" : "Node", + "desc" : "The old parent of this node", + "isOptional" : false + }, + { + "name" : "newParent", + "type" : "Node", + "desc" : "The new parent of this node", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index it was moved to", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "remove", "type" : "function", "desc" : "Fires when a child node is removed", "sig" : "function (tree, _self, node)\n{\n\n}", - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The removed node", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "textchange", "type" : "function", "desc" : "Fires when the text for this node is changed", "sig" : "function (_self, text, oldText)\n{\n\n}", - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "text", + "type" : "String", + "desc" : "The new text", + "isOptional" : false + }, + { + "name" : "oldText", + "type" : "String", + "desc" : "The old text", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -105498,7 +284817,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -105506,7 +284843,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "appendChild", @@ -105514,7 +284887,31 @@ "desc" : "Insert node(s) as the last child node of this node.", "sig" : "(node)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "Node/Array", + "desc" : "The node or Array of nodes to append", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The appended node if single append, or null if an array was passed" + } + ] }, { "name" : "bubble", @@ -105522,7 +284919,37 @@ "desc" : "Bubbles up the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped.", "sig" : "(fn, scope, args)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to current node)", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Array", + "desc" : "(optional) The args to call the function with (default to passing the current node)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "capture", @@ -105530,7 +284957,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "cascade", @@ -105538,7 +284995,37 @@ "desc" : "Cascades down the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch.", "sig" : "(fn, scope, args)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to current node)", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Array", + "desc" : "(optional) The args to call the function with (default to passing the current node)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "collapse", @@ -105546,7 +285033,31 @@ "desc" : "Collapse this node.", "sig" : "(deep, anim)", "static" : false, - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) True to collapse all children as well", + "isOptional" : false + }, + { + "name" : "anim", + "type" : "Boolean", + "desc" : "(optional) false to cancel the default animation", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "collapseChildNodes", @@ -105554,7 +285065,25 @@ "desc" : "Collapse all child nodes", "sig" : "(deep)", "static" : false, - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) true if the child nodes should also collapse their child nodes", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "contains", @@ -105562,7 +285091,31 @@ "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.", "sig" : "(node)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "disable", @@ -105570,7 +285123,18 @@ "desc" : "Disables this node", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "eachChild", @@ -105578,7 +285142,37 @@ "desc" : "Interates the child nodes of this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops.", "sig" : "(fn, scope, args)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to current node)", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Array", + "desc" : "(optional) The args to call the function with (default to passing the current node)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enable", @@ -105586,7 +285180,18 @@ "desc" : "Enables this node", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "ensureVisible", @@ -105594,7 +285199,18 @@ "desc" : "Ensures all parent nodes are expanded", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "expand", @@ -105602,7 +285218,37 @@ "desc" : "Expand this node.", "sig" : "(deep, anim, callback)", "static" : false, - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) True to expand all children as well", + "isOptional" : false + }, + { + "name" : "anim", + "type" : "Boolean", + "desc" : "(optional) false to cancel the default animation", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) A callback to be called when\nexpanding this node completes (does not wait for deep expand to complete).\nCalled with 1 parameter, this node.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "expandChildNodes", @@ -105610,7 +285256,25 @@ "desc" : "Expand all child nodes", "sig" : "(deep)", "static" : false, - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) true if the child nodes should also expand their child nodes", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "findChild", @@ -105618,7 +285282,37 @@ "desc" : "Finds the first child that has the attribute with the specified value.", "sig" : "(attribute, value)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "attribute", + "type" : "String", + "desc" : "The attribute name", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to search for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The found child or null if none was found" + } + ] }, { "name" : "findChildBy", @@ -105626,7 +285320,37 @@ "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.", "sig" : "(fn, scope)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The found child or null if none was found" + } + ] }, { "name" : "fireEvent", @@ -105634,7 +285358,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getDepth", @@ -105642,7 +285396,24 @@ "desc" : "Returns depth of this node (the root node has a depth of 0)", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] }, { "name" : "getOwnerTree", @@ -105650,7 +285421,24 @@ "desc" : "Returns the tree this node is in.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Tree", + "desc" : "" + } + ] }, { "name" : "getPath", @@ -105658,7 +285446,31 @@ "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.", "sig" : "(attr)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "attr", + "type" : "String", + "desc" : "(optional) The attr to use for the path (defaults to the node's id)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The path" + } + ] }, { "name" : "getUI", @@ -105666,7 +285478,24 @@ "desc" : "Returns the UI object for this node", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "TreeNodeUI", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -105674,7 +285503,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "indexOf", @@ -105682,7 +285535,31 @@ "desc" : "Returns the index of a child node", "sig" : "(node)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The index of the node or -1 if it was not found" + } + ] }, { "name" : "insertBefore", @@ -105690,7 +285567,37 @@ "desc" : "Inserts the first node before the second node in this nodes childNodes collection.", "sig" : "(node, refNode)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node to insert", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The node to insert before (if null the node is appended)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The inserted node" + } + ] }, { "name" : "isAncestor", @@ -105698,7 +285605,31 @@ "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.", "sig" : "(node)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isExpanded", @@ -105706,7 +285637,24 @@ "desc" : "Returns true if this node is expanded", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isFirst", @@ -105714,7 +285662,24 @@ "desc" : "Returns true if this node is the first child of its parent", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isLast", @@ -105722,7 +285687,24 @@ "desc" : "Returns true if this node is the last child of its parent", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isLeaf", @@ -105730,7 +285712,24 @@ "desc" : "Returns true if this node is a leaf", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isLoaded", @@ -105738,7 +285737,24 @@ "desc" : "Returns true if this node has been loaded", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isLoading", @@ -105746,7 +285762,24 @@ "desc" : "Returns true if this node is currently loading", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isSelected", @@ -105754,7 +285787,24 @@ "desc" : "Returns true if this node is selected", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "item", @@ -105762,7 +285812,31 @@ "desc" : "Returns the child node at the specified index.", "sig" : "(index)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "" + } + ] }, { "name" : "on", @@ -105770,7 +285844,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -105778,7 +285888,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -105786,7 +285907,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "reload", @@ -105794,7 +285933,25 @@ "desc" : "Trigger a reload for this node", "sig" : "(callback)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "callback", + "type" : "Function", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeChild", @@ -105802,7 +285959,31 @@ "desc" : "Removes a child node from this node.", "sig" : "(node)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node to remove", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The removed node" + } + ] }, { "name" : "removeListener", @@ -105810,7 +285991,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "replaceChild", @@ -105818,7 +286029,37 @@ "desc" : "Replaces one child node in this node with another.", "sig" : "(newChild, oldChild)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "newChild", + "type" : "Node", + "desc" : "The replacement node", + "isOptional" : false + }, + { + "name" : "oldChild", + "type" : "Node", + "desc" : "The node to replace", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The replaced node" + } + ] }, { "name" : "select", @@ -105826,7 +286067,18 @@ "desc" : "Triggers selection of this node", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setText", @@ -105834,7 +286086,25 @@ "desc" : "Sets the text for this node", "sig" : "(text)", "static" : false, - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "sort", @@ -105842,7 +286112,31 @@ "desc" : "Sorts this nodes children using the supplied sort function", "sig" : "(fn, scope)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "toggle", @@ -105850,7 +286144,18 @@ "desc" : "Toggles expanded/collapsed state of the node", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -105858,7 +286163,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "unselect", @@ -105866,7 +286201,18 @@ "desc" : "Triggers deselection of this node", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.tree.TreeNode" + "memberOf" : "Roo.tree.TreeNode", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -105891,7 +286237,26 @@ "type" : "function", "desc" : "Fire this event on a container when it resizes", "sig" : "function (w, h)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "w", + "type" : "int", + "desc" : "Width", + "isOptional" : false + }, + { + "name" : "h", + "type" : "int", + "desc" : "Height", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [] @@ -105911,14 +286276,58 @@ "type" : "function", "desc" : "Fires before the selected node changes, return false to cancel the change", "sig" : "function (_self, node, node)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "DefaultSelectionModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "node", + "type" : "TreeNode", + "desc" : "the new selection", + "isOptional" : false + }, + { + "name" : "node", + "type" : "TreeNode", + "desc" : "the old selection", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "selectionchange", "type" : "function", "desc" : "Fires when the selected node changes", "sig" : "function (_self, node)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "DefaultSelectionModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "node", + "type" : "TreeNode", + "desc" : "the new selection", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -105928,7 +286337,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -105936,7 +286363,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -105944,7 +286407,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearSelections", @@ -105952,7 +286445,18 @@ "desc" : "Clear all selections", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -105960,7 +286464,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getSelectedNode", @@ -105968,7 +286502,24 @@ "desc" : "Get the selected node", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "TreeNode", + "desc" : "The selected node" + } + ] }, { "name" : "hasListener", @@ -105976,7 +286527,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "isSelected", @@ -105984,7 +286559,31 @@ "desc" : "Returns true if the node is selected", "sig" : "(node)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "TreeNode", + "desc" : "The node to check", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "on", @@ -105992,7 +286591,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -106000,7 +286635,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -106008,7 +286654,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -106016,7 +286680,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "select", @@ -106024,7 +286718,31 @@ "desc" : "Select a node.", "sig" : "(node)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "TreeNode", + "desc" : "The node to select", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "TreeNode", + "desc" : "The selected node" + } + ] }, { "name" : "selectNext", @@ -106032,7 +286750,24 @@ "desc" : "Selects the node above the selected node in the tree, intelligently walking the nodes", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "TreeNode The new selection" + } + ] }, { "name" : "selectPrevious", @@ -106040,7 +286775,24 @@ "desc" : "Selects the node above the selected node in the tree, intelligently walking the nodes", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "", + "desc" : "TreeNode The new selection" + } + ] }, { "name" : "un", @@ -106048,7 +286800,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "unselect", @@ -106056,7 +286838,25 @@ "desc" : "Deselect a node.", "sig" : "(node)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "TreeNode", + "desc" : "The node to unselect", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -106075,7 +286875,26 @@ "type" : "function", "desc" : "Fires when the selected nodes change", "sig" : "function (_self, nodes)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "MultiSelectionModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "nodes", + "type" : "Array", + "desc" : "Array of the selected nodes", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -106085,7 +286904,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -106093,7 +286930,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -106101,7 +286974,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clearSelections", @@ -106109,7 +287012,18 @@ "desc" : "Clear all selections", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "fireEvent", @@ -106117,7 +287031,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getSelectedNodes", @@ -106125,7 +287069,24 @@ "desc" : "Returns an array of the selected nodes", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -106133,7 +287094,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "isSelected", @@ -106141,7 +287126,31 @@ "desc" : "Returns true if the node is selected", "sig" : "(node)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "TreeNode", + "desc" : "The node to check", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "on", @@ -106149,7 +287158,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -106157,7 +287202,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -106165,7 +287221,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -106173,7 +287247,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "select", @@ -106181,7 +287285,43 @@ "desc" : "Select a node.", "sig" : "(node, e, keepExisting)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "TreeNode", + "desc" : "The node to select", + "isOptional" : false + }, + { + "name" : "e", + "type" : "EventObject", + "desc" : "(optional) An event associated with the selection", + "isOptional" : false + }, + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "True to retain existing selections", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "TreeNode", + "desc" : "The selected node" + } + ] }, { "name" : "un", @@ -106189,7 +287329,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "unselect", @@ -106197,7 +287367,25 @@ "desc" : "Deselect a node.", "sig" : "(node)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "TreeNode", + "desc" : "The node to unselect", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -106259,8 +287447,8 @@ }, { "name" : "field", - "type" : "Roo.form.TextField|Object", - "desc" : "The field configuration", + "type" : "Roo.form.TextField", + "desc" : "[required] The field configuration", "memberOf" : "" }, { @@ -106273,11 +287461,7 @@ "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "ignoreNoChange", @@ -106340,112 +287524,374 @@ "type" : "function", "desc" : "Fires after a change has been made to the field, but before the change is reflected in the underlying\nfield. Saving the change to the field can be canceled by returning false from the handler of this event.\nNote that if the value has not changed and ignoreNoChange = true, the editing will still end but this\nevent will not fire since no edit actually occurred.", "sig" : "function (_self, value, startValue)\n{\n\n}", - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Editor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The current field value", + "isOptional" : false + }, + { + "name" : "startValue", + "type" : "Mixed", + "desc" : "The original field value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforenodeedit", "type" : "function", "desc" : "Fires when editing is initiated, but before the value changes. Editing can be canceled by returning\nfalse from the handler of this event.", "sig" : "function (_self, node)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Editor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Roo.tree.Node", + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforestartedit", "type" : "function", "desc" : "Fires when editing is initiated, but before the value changes. Editing can be canceled by returning\nfalse from the handler of this event.", "sig" : "function (_self, boundEl, value)\n{\n\n}", - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Editor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "boundEl", + "type" : "Roo.Element", + "desc" : "The underlying element bound to this editor", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The field value being set", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "complete", "type" : "function", "desc" : "Fires after editing is complete and any changed value has been written to the underlying field.", "sig" : "function (_self, value, startValue)\n{\n\n}", - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Editor", + "desc" : "", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The current field value", + "isOptional" : false + }, + { + "name" : "startValue", + "type" : "Mixed", + "desc" : "The original field value", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", "type" : "function", "desc" : "Fires after the component is destroyed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "Roo.Component" + "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" + "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" + "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" + "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" + "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" + "memberOf" : "Roo.Component", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.Component", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "specialkey", "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.form.Field", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "startedit", "type" : "function", "desc" : "Fires when this editor is displayed", "sig" : "function (boundEl, value)\n{\n\n}", - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "boundEl", + "type" : "Roo.Element", + "desc" : "The underlying element bound to this editor", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The starting field value", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -106455,7 +287901,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -106463,7 +287927,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "cancelEdit", @@ -106471,7 +287971,25 @@ "desc" : "Cancels the editing process and hides the editor without persisting any changes. The field value will be\nreverted to the original starting value.", "sig" : "(remainVisible)", "static" : false, - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "remainVisible", + "type" : "Boolean", + "desc" : "Override the default behavior and keep the editor visible after\ncancel (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "capture", @@ -106479,7 +287997,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "completeEdit", @@ -106487,7 +288035,25 @@ "desc" : "Ends the editing process, persists the changed value to the underlying field, and hides the editor.", "sig" : "(remainVisible)", "static" : false, - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "remainVisible", + "type" : "Boolean", + "desc" : "Override the default behavior and keep the editor visible after edit (defaults to false)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "destroy", @@ -106495,7 +288061,18 @@ "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" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "disable", @@ -106503,7 +288080,24 @@ "desc" : "Disable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "enable", @@ -106511,7 +288105,24 @@ "desc" : "Enable this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "fireEvent", @@ -106519,7 +288130,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "focus", @@ -106527,7 +288168,31 @@ "desc" : "Try to focus this component.", "sig" : "(selectText)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getEl", @@ -106535,7 +288200,24 @@ "desc" : "Returns the underlying {@link Roo.Element}.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "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" : "getId", @@ -106543,7 +288225,24 @@ "desc" : "Returns the id of this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "" + } + ] }, { "name" : "getValue", @@ -106551,7 +288250,24 @@ "desc" : "Gets the data value of the editor", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "The data value" + } + ] }, { "name" : "hasListener", @@ -106559,7 +288275,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "hide", @@ -106567,7 +288307,24 @@ "desc" : "Hide this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "isVisible", @@ -106575,7 +288332,18 @@ "desc" : "Returns true if this component is visible.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "on", @@ -106583,7 +288351,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -106591,7 +288395,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "realign", @@ -106599,7 +288414,18 @@ "desc" : "Realigns the editor to the bound field based on the current alignment config value.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -106607,7 +288433,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -106615,7 +288459,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -106623,7 +288497,25 @@ "desc" : "If this is a lazy rendering component, render it to its container element.", "sig" : "(container)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setDisabled", @@ -106631,7 +288523,25 @@ "desc" : "Convenience function for setting disabled/enabled by boolean.", "sig" : "(disabled)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "setSize", @@ -106639,7 +288549,31 @@ "desc" : "Sets the height and width of this editor.", "sig" : "(width, height)", "static" : false, - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "width", + "type" : "Number", + "desc" : "The new width", + "isOptional" : false + }, + { + "name" : "height", + "type" : "Number", + "desc" : "The new height", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setValue", @@ -106647,7 +288581,25 @@ "desc" : "Sets the data value of the editor", "sig" : "(value)", "static" : false, - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "Any valid value supported by the underlying field", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setVisible", @@ -106655,7 +288607,31 @@ "desc" : "Convenience function to hide or show this component by boolean.", "sig" : "(visible)", "static" : false, - "memberOf" : "Roo.Component" + "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" : "show", @@ -106663,7 +288639,24 @@ "desc" : "Show this component.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.Component" + "memberOf" : "Roo.Component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Roo.Component", + "desc" : "this" + } + ] }, { "name" : "startEdit", @@ -106671,7 +288664,31 @@ "desc" : "Starts the editing process and shows the editor.", "sig" : "(el, value)", "static" : false, - "memberOf" : "Roo.Editor" + "memberOf" : "Roo.Editor", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement/Element", + "desc" : "The element to edit", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String", + "desc" : "(optional) A value to initialize the editor with. If a value is not provided, it defaults\nto the innerHTML of el.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "un", @@ -106679,7 +288696,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -106693,7 +288740,18 @@ "desc" : "Clears the current filter. Note: with the \"remove\" option\nset a filter cannot be cleared.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "filter", @@ -106701,7 +288759,37 @@ "desc" : "Filter the data by a specific attribute.", "sig" : "(value, attr, startNode)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String/RegExp", + "desc" : "Either string that the attribute value\nshould start with or a RegExp to test against the attribute", + "isOptional" : false + }, + { + "name" : "attr", + "type" : "String", + "desc" : "(optional) The attribute passed in your node's attributes collection. Defaults to \"text\".", + "isOptional" : false + }, + { + "name" : "startNode", + "type" : "TreeNode", + "desc" : "(optional) The node to start the filter at.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "filterBy", @@ -106709,7 +288797,31 @@ "desc" : "Filter by a function. The passed function will be called with each\nnode in the tree (or from the startNode). If the function returns true, the node is kept\notherwise it is filtered. If a node is filtered, its children are also filtered.", "sig" : "(fn, scope)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The filter function", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to the current node)", + "isOptional" : false + } + ], + "returns" : [] } ] }, @@ -106776,28 +288888,122 @@ "type" : "function", "desc" : "Fires before a network request is made to retrieve the Json text which specifies a node's children.", "sig" : "function (This, node, callback)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "This", + "type" : "Object", + "desc" : "TreeLoader object.", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Object", + "desc" : "The {@link Roo.tree.TreeNode} object being loaded.", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Object", + "desc" : "The callback function specified in the {@link #load} call.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "create", "type" : "function", "desc" : "Fires before a node is created, enabling you to return custom Node types", "sig" : "function (This, attr)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "This", + "type" : "Object", + "desc" : "TreeLoader object.", + "isOptional" : false + }, + { + "name" : "attr", + "type" : "Object", + "desc" : "- the data returned from the AJAX call (modify it to suit)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "load", "type" : "function", "desc" : "Fires when the node has been successfuly loaded.", "sig" : "function (This, node, response)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "This", + "type" : "Object", + "desc" : "TreeLoader object.", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Object", + "desc" : "The {@link Roo.tree.TreeNode} object being loaded.", + "isOptional" : false + }, + { + "name" : "response", + "type" : "Object", + "desc" : "The response object containing the data from the server.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "loadexception", "type" : "function", "desc" : "Fires if the network request failed.", "sig" : "function (This, node, response)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "This", + "type" : "Object", + "desc" : "TreeLoader object.", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Object", + "desc" : "The {@link Roo.tree.TreeNode} object being loaded.", + "isOptional" : false + }, + { + "name" : "response", + "type" : "Object", + "desc" : "The response object containing the data from the server.", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -106807,7 +289013,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -106815,7 +289039,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -106823,7 +289083,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "fireEvent", @@ -106831,7 +289121,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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", @@ -106839,7 +289159,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "load", @@ -106847,7 +289191,31 @@ "desc" : "Load an {@link Roo.tree.TreeNode} from the URL specified in the constructor.\nThis is called automatically when a node is expanded, but may be used to reload\na node (or append new children if the {@link #clearOnLoad} option is false.)", "sig" : "(node, callback)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "Roo.tree.TreeNode", + "desc" : "", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "on", @@ -106855,7 +289223,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -106863,7 +289267,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -106871,7 +289286,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -106879,7 +289312,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "un", @@ -106887,7 +289350,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -107008,140 +289501,610 @@ "type" : "function", "desc" : "Fires when a new child node is appended", "sig" : "function (tree, _self, node, index)\n{\n\n}", - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The newly appended node", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the newly appended node", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeappend", "type" : "function", "desc" : "Fires before a new child is appended, return false to cancel the append.", "sig" : "function (tree, _self, node)\n{\n\n}", - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be appended", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforechildrenrendered", "type" : "function", "desc" : "Fires right before the child nodes for this node are rendered", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeclick", "type" : "function", "desc" : "Fires before click processing. Return false to cancel the default action.", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforecollapse", "type" : "function", "desc" : "Fires before this node is collapsed, return false to cancel.", "sig" : "function (_self, deep, anim)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "deep", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + }, + { + "name" : "anim", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeexpand", "type" : "function", "desc" : "Fires before this node is expanded, return false to cancel.", "sig" : "function (_self, deep, anim)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "deep", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + }, + { + "name" : "anim", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeinsert", "type" : "function", "desc" : "Fires before a new child is inserted, return false to cancel the insert.", "sig" : "function (tree, _self, node, refNode)\n{\n\n}", - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be inserted", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The child node the node is being inserted before", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforemove", "type" : "function", "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.", "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}", - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "oldParent", + "type" : "Node", + "desc" : "The parent of this node", + "isOptional" : false + }, + { + "name" : "newParent", + "type" : "Node", + "desc" : "The new parent this node is moving to", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index it is being moved to", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeremove", "type" : "function", "desc" : "Fires before a child is removed, return false to cancel the remove.", "sig" : "function (tree, _self, node)\n{\n\n}", - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be removed", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "checkchange", "type" : "function", "desc" : "Fires when a node with a checkbox's checked property changes", "sig" : "function (_self, checked)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fires when this node is clicked", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "collapse", "type" : "function", "desc" : "Fires when this node is collapsed", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "contextmenu", "type" : "function", "desc" : "Fires when this node is right clicked", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dblclick", "type" : "function", "desc" : "Fires when this node is double clicked", "sig" : "function (_self, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "disabledchange", "type" : "function", "desc" : "Fires when the disabled status of this node changes", "sig" : "function (_self, disabled)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "expand", "type" : "function", "desc" : "Fires when this node is expanded", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "insert", "type" : "function", "desc" : "Fires when a new child node is inserted.", "sig" : "function (tree, _self, node, refNode)\n{\n\n}", - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node inserted", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The child node the node was inserted before", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires when this node is moved to a new location in the tree", "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}", - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "oldParent", + "type" : "Node", + "desc" : "The old parent of this node", + "isOptional" : false + }, + { + "name" : "newParent", + "type" : "Node", + "desc" : "The new parent of this node", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index it was moved to", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "remove", "type" : "function", "desc" : "Fires when a child node is removed", "sig" : "function (tree, _self, node)\n{\n\n}", - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The removed node", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "textchange", "type" : "function", "desc" : "Fires when the text for this node is changed", "sig" : "function (_self, text, oldText)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "text", + "type" : "String", + "desc" : "The new text", + "isOptional" : false + }, + { + "name" : "oldText", + "type" : "String", + "desc" : "The old text", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -107151,7 +290114,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -107159,7 +290140,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "appendChild", @@ -107167,7 +290184,31 @@ "desc" : "Insert node(s) as the last child node of this node.", "sig" : "(node)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "Node/Array", + "desc" : "The node or Array of nodes to append", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The appended node if single append, or null if an array was passed" + } + ] }, { "name" : "bubble", @@ -107175,7 +290216,37 @@ "desc" : "Bubbles up the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped.", "sig" : "(fn, scope, args)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to current node)", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Array", + "desc" : "(optional) The args to call the function with (default to passing the current node)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "capture", @@ -107183,7 +290254,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "cascade", @@ -107191,7 +290292,37 @@ "desc" : "Cascades down the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch.", "sig" : "(fn, scope, args)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to current node)", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Array", + "desc" : "(optional) The args to call the function with (default to passing the current node)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "collapse", @@ -107199,7 +290330,31 @@ "desc" : "Collapse this node.", "sig" : "(deep, anim)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) True to collapse all children as well", + "isOptional" : false + }, + { + "name" : "anim", + "type" : "Boolean", + "desc" : "(optional) false to cancel the default animation", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "collapseChildNodes", @@ -107207,7 +290362,25 @@ "desc" : "Collapse all child nodes", "sig" : "(deep)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) true if the child nodes should also collapse their child nodes", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "contains", @@ -107215,7 +290388,31 @@ "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.", "sig" : "(node)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "disable", @@ -107223,7 +290420,18 @@ "desc" : "Disables this node", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "eachChild", @@ -107231,7 +290439,37 @@ "desc" : "Interates the child nodes of this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops.", "sig" : "(fn, scope, args)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to current node)", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Array", + "desc" : "(optional) The args to call the function with (default to passing the current node)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enable", @@ -107239,7 +290477,18 @@ "desc" : "Enables this node", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "ensureVisible", @@ -107247,7 +290496,18 @@ "desc" : "Ensures all parent nodes are expanded", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "expand", @@ -107255,7 +290515,37 @@ "desc" : "Expand this node.", "sig" : "(deep, anim, callback)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) True to expand all children as well", + "isOptional" : false + }, + { + "name" : "anim", + "type" : "Boolean", + "desc" : "(optional) false to cancel the default animation", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) A callback to be called when\nexpanding this node completes (does not wait for deep expand to complete).\nCalled with 1 parameter, this node.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "expandChildNodes", @@ -107263,7 +290553,25 @@ "desc" : "Expand all child nodes", "sig" : "(deep)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "deep", + "type" : "Boolean", + "desc" : "(optional) true if the child nodes should also expand their child nodes", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "findChild", @@ -107271,7 +290579,37 @@ "desc" : "Finds the first child that has the attribute with the specified value.", "sig" : "(attribute, value)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "attribute", + "type" : "String", + "desc" : "The attribute name", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to search for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The found child or null if none was found" + } + ] }, { "name" : "findChildBy", @@ -107279,7 +290617,37 @@ "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.", "sig" : "(fn, scope)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The found child or null if none was found" + } + ] }, { "name" : "fireEvent", @@ -107287,7 +290655,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getDepth", @@ -107295,7 +290693,24 @@ "desc" : "Returns depth of this node (the root node has a depth of 0)", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] }, { "name" : "getOwnerTree", @@ -107303,7 +290718,24 @@ "desc" : "Returns the tree this node is in.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Tree", + "desc" : "" + } + ] }, { "name" : "getPath", @@ -107311,7 +290743,31 @@ "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.", "sig" : "(attr)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "attr", + "type" : "String", + "desc" : "(optional) The attr to use for the path (defaults to the node's id)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The path" + } + ] }, { "name" : "getUI", @@ -107319,7 +290775,24 @@ "desc" : "Returns the UI object for this node", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "TreeNodeUI", + "desc" : "" + } + ] }, { "name" : "hasListener", @@ -107327,7 +290800,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "indexOf", @@ -107335,7 +290832,31 @@ "desc" : "Returns the index of a child node", "sig" : "(node)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "The index of the node or -1 if it was not found" + } + ] }, { "name" : "insertBefore", @@ -107343,7 +290864,37 @@ "desc" : "Inserts the first node before the second node in this nodes childNodes collection.", "sig" : "(node, refNode)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node to insert", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The node to insert before (if null the node is appended)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The inserted node" + } + ] }, { "name" : "isAncestor", @@ -107351,7 +290902,31 @@ "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.", "sig" : "(node)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isExpanded", @@ -107359,7 +290934,24 @@ "desc" : "Returns true if this node is expanded", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isFirst", @@ -107367,7 +290959,24 @@ "desc" : "Returns true if this node is the first child of its parent", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isLast", @@ -107375,7 +290984,24 @@ "desc" : "Returns true if this node is the last child of its parent", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isLeaf", @@ -107383,7 +291009,24 @@ "desc" : "Returns true if this node is a leaf", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "isSelected", @@ -107391,7 +291034,24 @@ "desc" : "Returns true if this node is selected", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] }, { "name" : "item", @@ -107399,7 +291059,31 @@ "desc" : "Returns the child node at the specified index.", "sig" : "(index)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "" + } + ] }, { "name" : "on", @@ -107407,7 +291091,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -107415,7 +291135,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -107423,7 +291154,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "removeChild", @@ -107431,7 +291180,31 @@ "desc" : "Removes a child node from this node.", "sig" : "(node)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node to remove", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The removed node" + } + ] }, { "name" : "removeListener", @@ -107439,7 +291212,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "replaceChild", @@ -107447,7 +291250,37 @@ "desc" : "Replaces one child node in this node with another.", "sig" : "(newChild, oldChild)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "newChild", + "type" : "Node", + "desc" : "The replacement node", + "isOptional" : false + }, + { + "name" : "oldChild", + "type" : "Node", + "desc" : "The node to replace", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "The replaced node" + } + ] }, { "name" : "select", @@ -107455,7 +291288,18 @@ "desc" : "Triggers selection of this node", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setText", @@ -107463,7 +291307,25 @@ "desc" : "Sets the text for this node", "sig" : "(text)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "text", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "sort", @@ -107471,7 +291333,31 @@ "desc" : "Sorts this nodes children using the supplied sort function", "sig" : "(fn, scope)", "static" : false, - "memberOf" : "Roo.data.Node" + "memberOf" : "Roo.data.Node", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "toggle", @@ -107479,7 +291365,18 @@ "desc" : "Toggles expanded/collapsed state of the node", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "un", @@ -107487,7 +291384,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "unselect", @@ -107495,7 +291422,18 @@ "desc" : "Triggers deselection of this node", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, @@ -107550,8 +291488,8 @@ }, { "name" : "editor", - "type" : "Object|Roo.tree.TreeEditor", - "desc" : "The TreeEditor or xtype data to display when clicked.", + "type" : "Roo.tree.TreeEditor", + "desc" : "The TreeEditor to display when clicked.", "memberOf" : "" }, { @@ -107598,7 +291536,7 @@ }, { "name" : "loader", - "type" : "Boolean", + "type" : "Roo.tree.TreeLoader", "desc" : "A TreeLoader for use with this TreePanel", "memberOf" : "" }, @@ -107620,6 +291558,12 @@ "desc" : "DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes hovertip to return HTML markup for the tree view. The render function is called with the following parameters:", "memberOf" : "" }, + { + "name" : "root", + "type" : "Roo.tree.TreeNode", + "desc" : "The root node", + "memberOf" : "" + }, { "name" : "rootVisible", "type" : "Boolean", @@ -107645,203 +291589,844 @@ "type" : "function", "desc" : "Fires when a new child node is appended to a node in this tree.", "sig" : "function (tree, parent, node, index)\n{\n\n}", - "memberOf" : "Roo.data.Tree" + "memberOf" : "Roo.data.Tree", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The newly appended node", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the newly appended node", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "appendnode", "type" : "function", "desc" : "Fires when append node to the tree", "sig" : "function (_self, node, index)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.tree.TreePanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Roo.tree.TreeNode", + "desc" : "", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the newly appended node", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeappend", "type" : "function", "desc" : "Fires before a new child is appended to a node in this tree, return false to cancel the append.", "sig" : "function (tree, parent, node)\n{\n\n}", - "memberOf" : "Roo.data.Tree" + "memberOf" : "Roo.data.Tree", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be appended", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforechildrenrendered", "type" : "function", "desc" : "Fires right before the child nodes for a node are rendered", "sig" : "function (node)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeclick", "type" : "function", "desc" : "Fires before click processing on a node. Return false to cancel the default action.", "sig" : "function (node, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforecollapse", "type" : "function", "desc" : "Fires before a node is collapsed, return false to cancel.", "sig" : "function (node, deep, anim)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node", + "isOptional" : false + }, + { + "name" : "deep", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + }, + { + "name" : "anim", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeexpand", "type" : "function", "desc" : "Fires before a node is expanded, return false to cancel.", "sig" : "function (node, deep, anim)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node", + "isOptional" : false + }, + { + "name" : "deep", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + }, + { + "name" : "anim", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeinsert", "type" : "function", "desc" : "Fires before a new child is inserted in a node in this tree, return false to cancel the insert.", "sig" : "function (tree, parent, node, refNode)\n{\n\n}", - "memberOf" : "Roo.data.Tree" + "memberOf" : "Roo.data.Tree", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be inserted", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The child node the node is being inserted before", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeload", "type" : "function", "desc" : "Fires before a node is loaded, return false to cancel", "sig" : "function (node)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node being loaded", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforemove", "type" : "function", "desc" : "Fires before a node is moved to a new location in the tree. Return false to cancel the move.", "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}", - "memberOf" : "Roo.data.Tree" + "memberOf" : "Roo.data.Tree", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The node being moved", + "isOptional" : false + }, + { + "name" : "oldParent", + "type" : "Node", + "desc" : "The parent of the node", + "isOptional" : false + }, + { + "name" : "newParent", + "type" : "Node", + "desc" : "The new parent the node is moving to", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index it is being moved to", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforenodedrop", "type" : "function", "desc" : "Fires when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The dropEvent\npassed to handlers has the following properties:
\n", "sig" : "function (dropEvent)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "dropEvent", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "beforeremove", "type" : "function", "desc" : "Fires before a child is removed from a node in this tree, return false to cancel the remove.", "sig" : "function (tree, parent, node)\n{\n\n}", - "memberOf" : "Roo.data.Tree" + "memberOf" : "Roo.data.Tree", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node to be removed", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "checkchange", "type" : "function", "desc" : "Fires when a node with a checkbox's checked property changes", "sig" : "function (_self, checked)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Node", + "desc" : "This node", + "isOptional" : false + }, + { + "name" : "checked", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "click", "type" : "function", "desc" : "Fires when a node is clicked", "sig" : "function (node, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "collapse", "type" : "function", "desc" : "Fires when a node is collapsed", "sig" : "function (node)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "contextmenu", "type" : "function", "desc" : "Fires when a node is right clicked", "sig" : "function (node, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dblclick", "type" : "function", "desc" : "Fires when a node is double clicked", "sig" : "function (node, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node", + "isOptional" : false + }, + { + "name" : "e", + "type" : "Roo.EventObject", + "desc" : "The event object", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "disabledchange", "type" : "function", "desc" : "Fires when the disabled status of a node changes", "sig" : "function (node, disabled)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node", + "isOptional" : false + }, + { + "name" : "disabled", + "type" : "Boolean", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "dragdrop", "type" : "function", "desc" : "Fires when a dragged node is dropped on a valid DD target", "sig" : "function (_self, node, dd, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.tree.TreePanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Roo.tree.TreeNode", + "desc" : "", + "isOptional" : false + }, + { + "name" : "dd", + "type" : "DD", + "desc" : "The dd it was dropped on", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "enddrag", "type" : "function", "desc" : "Fires when a drag operation is complete", "sig" : "function (_self, node, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.tree.TreePanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Roo.tree.TreeNode", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "expand", "type" : "function", "desc" : "Fires when a node is expanded", "sig" : "function (node)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "insert", "type" : "function", "desc" : "Fires when a new child node is inserted in a node in this tree.", "sig" : "function (tree, parent, node, refNode)\n{\n\n}", - "memberOf" : "Roo.data.Tree" + "memberOf" : "Roo.data.Tree", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node inserted", + "isOptional" : false + }, + { + "name" : "refNode", + "type" : "Node", + "desc" : "The child node the node was inserted before", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "load", "type" : "function", "desc" : "Fires when a node is loaded", "sig" : "function (node)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node that was loaded", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "move", "type" : "function", "desc" : "Fires when a node is moved to a new location in the tree", "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}", - "memberOf" : "Roo.data.Tree" + "memberOf" : "Roo.data.Tree", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The node moved", + "isOptional" : false + }, + { + "name" : "oldParent", + "type" : "Node", + "desc" : "The old parent of this node", + "isOptional" : false + }, + { + "name" : "newParent", + "type" : "Node", + "desc" : "The new parent of this node", + "isOptional" : false + }, + { + "name" : "index", + "type" : "Number", + "desc" : "The index it was moved to", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "nodedragover", "type" : "function", "desc" : "Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. The dragOverEvent\npassed to handlers has the following properties:
\n", "sig" : "function (dragOverEvent)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "dragOverEvent", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "nodedrop", "type" : "function", "desc" : "Fires after a DD object is dropped on a node in this tree. The dropEvent\npassed to handlers has the following properties:
\n", "sig" : "function (dropEvent)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "dropEvent", + "type" : "Object", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "remove", "type" : "function", "desc" : "Fires when a child node is removed from a node in this tree.", "sig" : "function (tree, parent, node)\n{\n\n}", - "memberOf" : "Roo.data.Tree" + "memberOf" : "Roo.data.Tree", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "tree", + "type" : "Tree", + "desc" : "The owner tree", + "isOptional" : false + }, + { + "name" : "parent", + "type" : "Node", + "desc" : "The parent node", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Node", + "desc" : "The child node removed", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "startdrag", "type" : "function", "desc" : "Fires when a node starts being dragged", "sig" : "function (_self, node, e)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.tree.TreePanel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "node", + "type" : "Roo.tree.TreeNode", + "desc" : "", + "isOptional" : false + }, + { + "name" : "e", + "type" : "event", + "desc" : "The raw browser event", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "textchange", "type" : "function", "desc" : "Fires when the text for a node is changed", "sig" : "function (node, text, oldText)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "The node", + "isOptional" : false + }, + { + "name" : "text", + "type" : "String", + "desc" : "The new text", + "isOptional" : false + }, + { + "name" : "oldText", + "type" : "String", + "desc" : "The old text", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -107851,7 +292436,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -107859,7 +292462,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -107867,7 +292506,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "collapseAll", @@ -107875,7 +292544,18 @@ "desc" : "Collapse all nodes", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "expandAll", @@ -107883,7 +292563,18 @@ "desc" : "Expand all nodes", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "expandPath", @@ -107891,7 +292582,37 @@ "desc" : "Expands a specified path in this TreePanel. A path can be retrieved from a node with {@link Roo.data.Node#getPath}", "sig" : "(path, attr, callback)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "path", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "attr", + "type" : "String", + "desc" : "(optional) The attribute used in the path (see {@link Roo.data.Node#getPath} for more info)", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) The callback to call when the expand is complete. The callback will be called with\n(bSuccess, oLastNode) where bSuccess is if the expand was successful and oLastNode is the last node that was expanded.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "fireEvent", @@ -107899,7 +292620,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "getChecked", @@ -107907,7 +292658,37 @@ "desc" : "Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. \"id\")", "sig" : "(attribute, startNode)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "attribute", + "type" : "String", + "desc" : "(optional) Defaults to null (return the actual nodes)", + "isOptional" : false + }, + { + "name" : "startNode", + "type" : "TreeNode", + "desc" : "(optional) The node to start from, defaults to the root", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "" + } + ] }, { "name" : "getEl", @@ -107915,7 +292696,18 @@ "desc" : "Returns the container element for this TreePanel", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "getLoader", @@ -107923,7 +292715,18 @@ "desc" : "Returns the default TreeLoader for this TreePanel", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "getNodeById", @@ -107931,7 +292734,31 @@ "desc" : "Gets a node in this tree by its id.", "sig" : "(id)", "static" : false, - "memberOf" : "Roo.data.Tree" + "memberOf" : "Roo.data.Tree", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "" + } + ] }, { "name" : "getRootNode", @@ -107939,7 +292766,24 @@ "desc" : "Returns the root node for this tree.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.data.Tree" + "memberOf" : "Roo.data.Tree", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "" + } + ] }, { "name" : "getSelectionModel", @@ -107947,7 +292791,18 @@ "desc" : "Returns the selection model used by this TreePanel", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasListener", @@ -107955,7 +292810,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "on", @@ -107963,7 +292842,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -107971,7 +292886,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -107979,7 +292905,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -107987,7 +292931,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "render", @@ -107995,7 +292969,18 @@ "desc" : "Trigger rendering of this TreePanel", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "selectPath", @@ -108003,7 +292988,37 @@ "desc" : "Selects the node in this tree at the specified path. A path can be retrieved from a node with {@link Roo.data.Node#getPath}", "sig" : "(path, attr, callback)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "path", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "attr", + "type" : "String", + "desc" : "(optional) The attribute used in the path (see {@link Roo.data.Node#getPath} for more info)", + "isOptional" : false + }, + { + "name" : "callback", + "type" : "Function", + "desc" : "(optional) The callback to call when the selection is complete. The callback will be called with\n(bSuccess, oSelNode) where bSuccess is if the selection was successful and oSelNode is the selected node.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "setRootNode", @@ -108011,7 +293026,31 @@ "desc" : "Sets the root node for this tree.", "sig" : "(node)", "static" : false, - "memberOf" : "Roo.data.Tree" + "memberOf" : "Roo.data.Tree", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "node", + "type" : "Node", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Node", + "desc" : "" + } + ] }, { "name" : "un", @@ -108019,7 +293058,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -108080,7 +293149,37 @@ "desc" : "Very simple dynamic creation of stylesheets from a text blob of rules. The text will wrapped in a style\ntag and appended to the HEAD of the document.", "sig" : "(cssText, id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "cssText", + "type" : "String|Object", + "desc" : "The text containing the css rules", + "isOptional" : false + }, + { + "name" : "id", + "type" : "String", + "desc" : "An id to add to the stylesheet for later removal", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "StyleSheet", + "desc" : "" + } + ] }, { "name" : "getRule", @@ -108088,7 +293187,37 @@ "desc" : "Gets an an individual CSS rule by selector(s)", "sig" : "(selector, refreshCache)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "selector", + "type" : "String/Array", + "desc" : "The CSS selector or an array of selectors to try. The first selector that is found is returned.", + "isOptional" : false + }, + { + "name" : "refreshCache", + "type" : "Boolean", + "desc" : "true to refresh the internal cache if you have recently updated any rules or added styles dynamically", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "CSSRule", + "desc" : "The CSS rule or null if one is not found" + } + ] }, { "name" : "getRules", @@ -108096,7 +293225,31 @@ "desc" : "Gets all css rules for the document", "sig" : "(refreshCache)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "refreshCache", + "type" : "Boolean", + "desc" : "true to refresh the internal cache", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object (hash) of rules indexed by selector" + } + ] }, { "name" : "refreshCache", @@ -108104,7 +293257,24 @@ "desc" : "Refresh the rule cache if you have dynamically added stylesheets", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object (hash) of rules indexed by selector" + } + ] }, { "name" : "removeStyleSheet", @@ -108112,7 +293282,25 @@ "desc" : "Removes a style or link tag by id", "sig" : "(id)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id of the tag", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "swapStyleSheet", @@ -108120,7 +293308,31 @@ "desc" : "Dynamically swaps an existing stylesheet reference for a new one", "sig" : "(id, url)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "id", + "type" : "String", + "desc" : "The id of an existing link tag to remove", + "isOptional" : false + }, + { + "name" : "url", + "type" : "String", + "desc" : "The href of the new stylesheet to include", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "updateRule", @@ -108128,7 +293340,43 @@ "desc" : "Updates a rule property", "sig" : "(selector, property, value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "selector", + "type" : "String/Array", + "desc" : "If it's an array it tries each selector until it finds one. Stops immediately once one is found.", + "isOptional" : false + }, + { + "name" : "property", + "type" : "String", + "desc" : "The css property", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String", + "desc" : "The new value for the property", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "true If a rule was found and updated" + } + ] } ] }, @@ -108189,21 +293437,60 @@ "type" : "function", "desc" : "Fires on a specified interval during the time the element is pressed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.util.ClickRepeater", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mousedown", "type" : "function", "desc" : "Fires when the mouse button is depressed.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.util.ClickRepeater", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "mouseup", "type" : "function", "desc" : "Fires when the mouse key is released.", "sig" : "function (_self)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "Roo.util.ClickRepeater", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -108213,7 +293500,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -108221,7 +293526,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -108229,7 +293570,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "fireEvent", @@ -108237,7 +293608,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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", @@ -108245,7 +293646,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "on", @@ -108253,7 +293678,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -108261,7 +293722,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -108269,7 +293741,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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", @@ -108277,7 +293767,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "un", @@ -108285,7 +293805,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -108309,7 +293859,31 @@ "desc" : "Converts the first character only of a string to upper case", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The text to convert", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The converted text" + } + ] }, { "name" : "date", @@ -108317,7 +293891,37 @@ "desc" : "Parse a value into a formatted date using the specified format pattern.", "sig" : "(value, format)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The value to format", + "isOptional" : false + }, + { + "name" : "format", + "type" : "String", + "desc" : "(optional) Any valid date format string (defaults to 'm/d/Y')", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The formatted date string" + } + ] }, { "name" : "dateRenderer", @@ -108325,7 +293929,31 @@ "desc" : "Returns a date rendering function that can be reused to apply a date format multiple times efficiently", "sig" : "(format)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "format", + "type" : "String", + "desc" : "Any valid date format string", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Function", + "desc" : "The date formatting function" + } + ] }, { "name" : "ellipsis", @@ -108333,7 +293961,37 @@ "desc" : "Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length", "sig" : "(value, length)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The string to truncate", + "isOptional" : false + }, + { + "name" : "length", + "type" : "Number", + "desc" : "The maximum length to allow before truncating", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The converted text" + } + ] }, { "name" : "htmlDecode", @@ -108341,7 +293999,31 @@ "desc" : "Convert certain characters (&, <, >, and ') from their HTML character equivalents.", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The string to decode", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The decoded text" + } + ] }, { "name" : "htmlEncode", @@ -108349,7 +294031,31 @@ "desc" : "Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages.", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The string to encode", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The encoded text" + } + ] }, { "name" : "lowercase", @@ -108357,7 +294063,31 @@ "desc" : "Converts a string to all lower case letters", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The text to convert", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The converted text" + } + ] }, { "name" : "number", @@ -108365,7 +294095,43 @@ "desc" : "Format a number\neventually this should probably emulate php's number_format", "sig" : "(value, decimals, delimiter)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Number/String", + "desc" : "The numeric value to format", + "isOptional" : false + }, + { + "name" : "decimals", + "type" : "Number", + "desc" : "number of decimal places", + "isOptional" : false + }, + { + "name" : "delimiter", + "type" : "String", + "desc" : "for thousands (default comma)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The formatted currency string" + } + ] }, { "name" : "size", @@ -108373,7 +294139,37 @@ "desc" : "Size in Mb,Gb etc.", "sig" : "(value, decimals)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Number", + "desc" : "The number to be formated", + "isOptional" : false + }, + { + "name" : "decimals", + "type" : "number", + "desc" : "how many decimal places", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "the formated string" + } + ] }, { "name" : "stripTags", @@ -108381,7 +294177,31 @@ "desc" : "Strips all HTML tags", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "The text from which to strip tags", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The stripped text" + } + ] }, { "name" : "substr", @@ -108389,7 +294209,43 @@ "desc" : "Returns a substring from within an original string", "sig" : "(value, start, length)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The original text", + "isOptional" : false + }, + { + "name" : "start", + "type" : "Number", + "desc" : "The start index of the substring", + "isOptional" : false + }, + { + "name" : "length", + "type" : "Number", + "desc" : "The length of the substring", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The substring" + } + ] }, { "name" : "toFixed", @@ -108397,7 +294253,37 @@ "desc" : "safer version of Math.toFixed..??/", "sig" : "(value, value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Number/String", + "desc" : "The numeric value to format", + "isOptional" : false + }, + { + "name" : "value", + "type" : "Number/String", + "desc" : "Decimal places", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The formatted currency string" + } + ] }, { "name" : "trim", @@ -108405,7 +294291,31 @@ "desc" : "Trims any whitespace from either side of a string", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The text to trim", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The trimmed text" + } + ] }, { "name" : "undef", @@ -108413,7 +294323,31 @@ "desc" : "Checks a reference and converts it to empty string if it is undefined", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Mixed", + "desc" : "Reference to check", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Mixed", + "desc" : "Empty string if converted, otherwise the original value" + } + ] }, { "name" : "uppercase", @@ -108421,7 +294355,31 @@ "desc" : "Converts a string to all upper case letters", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The text to convert", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The converted text" + } + ] }, { "name" : "usMoney", @@ -108429,7 +294387,31 @@ "desc" : "Format a number as US currency", "sig" : "(value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "Number/String", + "desc" : "The numeric value to format", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The formatted currency string" + } + ] } ] }, @@ -108453,28 +294435,103 @@ "type" : "function", "desc" : "Fires when an item is added to the collection.", "sig" : "function (index, o, key)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index at which the item was added.", + "isOptional" : false + }, + { + "name" : "o", + "type" : "Object", + "desc" : "The item added.", + "isOptional" : false + }, + { + "name" : "key", + "type" : "String", + "desc" : "The key associated with the added item.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "clear", "type" : "function", "desc" : "Fires when the collection is cleared.", "sig" : "function ()\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [], + "returns" : [] }, { "name" : "remove", "type" : "function", "desc" : "Fires when an item is removed from the collection.", "sig" : "function (o, key)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Object", + "desc" : "The item being removed.", + "isOptional" : false + }, + { + "name" : "key", + "type" : "String", + "desc" : "(optional) The key associated with the removed item.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "replace", "type" : "function", "desc" : "Fires when an item is replaced in the collection.", "sig" : "function (key, old, new)\n{\n\n}", - "memberOf" : "" + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "key", + "type" : "String", + "desc" : "he key associated with the new added.", + "isOptional" : false + }, + { + "name" : "old", + "type" : "Object", + "desc" : "The item being replaced.", + "isOptional" : false + }, + { + "name" : "new", + "type" : "Object", + "desc" : "The new item.", + "isOptional" : false + } + ], + "returns" : [] } ], "methods" : [ @@ -108484,7 +294541,37 @@ "desc" : "Adds an item to the collection.", "sig" : "(key, o)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "key", + "type" : "String", + "desc" : "The key to associate with the item", + "isOptional" : false + }, + { + "name" : "o", + "type" : "Object", + "desc" : "The item to add.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The item added." + } + ] }, { "name" : "addAll", @@ -108492,7 +294579,25 @@ "desc" : "Adds all elements of an Array or an Object to the collection.", "sig" : "(objs)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "objs", + "type" : "Object/Array", + "desc" : "An Object containing properties which will be added to the collection, or\nan Array of values, each of which are added to the collection.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "addEvents", @@ -108500,7 +294605,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "addListener", @@ -108508,7 +294631,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] }, { "name" : "capture", @@ -108516,7 +294675,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" + "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" : "clear", @@ -108524,7 +294713,18 @@ "desc" : "Removes all items from the collection.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "clone", @@ -108532,7 +294732,24 @@ "desc" : "Creates a duplicate of this collection", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "MixedCollection", + "desc" : "" + } + ] }, { "name" : "contains", @@ -108540,7 +294757,31 @@ "desc" : "Returns true if the collection contains the passed Object as an item.", "sig" : "(o)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "o", + "type" : "Object", + "desc" : "The Object to look for in the collection.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the collection contains the Object as an item." + } + ] }, { "name" : "containsKey", @@ -108548,7 +294789,31 @@ "desc" : "Returns true if the collection contains the passed Object as a key.", "sig" : "(key)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "key", + "type" : "String", + "desc" : "The key to look for in the collection.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the collection contains the Object as a key." + } + ] }, { "name" : "each", @@ -108556,7 +294821,31 @@ "desc" : "Executes the specified function once for every item in the collection, passing each\nitem as the first and only parameter. returning false from the function will stop the iteration.", "sig" : "(fn, scope)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to execute for each item.", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the function.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "eachKey", @@ -108564,7 +294853,31 @@ "desc" : "Executes the specified function once for every key in the collection, passing each\nkey, and its associated item as the first two parameters.", "sig" : "(fn, scope)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to execute for each item.", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the function.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "filter", @@ -108572,7 +294885,37 @@ "desc" : "Filter the objects in this collection by a specific property. \nReturns a new collection that has been filtered.", "sig" : "(property, value)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "property", + "type" : "String", + "desc" : "A property on your objects", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String/RegExp", + "desc" : "Either string that the property values \nshould start with or a RegExp to test against the property", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "MixedCollection", + "desc" : "The new filtered collection" + } + ] }, { "name" : "filterBy", @@ -108580,7 +294923,37 @@ "desc" : "Filter by a function. * Returns a new collection that has been filtered.\nThe passed function will be called with each \nobject in the collection. If the function returns true, the value is included \notherwise it is filtered.", "sig" : "(fn, scope)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to be called, it will receive the args o (the object), k (the key)", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope of the function (defaults to this)", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "MixedCollection", + "desc" : "The new filtered collection" + } + ] }, { "name" : "find", @@ -108588,7 +294961,37 @@ "desc" : "Returns the first item in the collection which elicits a true return value from the\npassed selection function.", "sig" : "(fn, scope)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "fn", + "type" : "Function", + "desc" : "The selection function to execute for each item.", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the function.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The first item in the collection which returned true from the selection function." + } + ] }, { "name" : "fireEvent", @@ -108596,7 +294999,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "first", @@ -108604,7 +295037,24 @@ "desc" : "Returns the first item in the collection.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "the first item in the collection.." + } + ] }, { "name" : "get", @@ -108612,7 +295062,31 @@ "desc" : "Returns the item associated with the passed key or index.", "sig" : "(key)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "key", + "type" : "String/Number", + "desc" : "The key or index of the item.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The item associated with the passed key." + } + ] }, { "name" : "getCount", @@ -108620,7 +295094,24 @@ "desc" : "Returns the number of items in the collection.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "the number of items in the collection." + } + ] }, { "name" : "getKey", @@ -108628,7 +295119,31 @@ "desc" : "MixedCollection has a generic way to fetch keys if you implement getKey.\n
\n// normal way\nvar mc = new Roo.util.MixedCollection();\nmc.add(someEl.dom.id, someEl);\nmc.add(otherEl.dom.id, otherEl);\n//and so on\n\n// using getKey\nvar mc = new Roo.util.MixedCollection();\nmc.getKey = function(el){\n   return el.dom.id;\n};\nmc.add(someEl);\nmc.add(otherEl);\n\n// or via the constructor\nvar mc = new Roo.util.MixedCollection(false, function(el){\n   return el.dom.id;\n});\nmc.add(someEl);\nmc.add(otherEl);\n
", "sig" : "(o)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "o", + "type" : "", + "desc" : "{Object} The item for which to find the key.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The key for the passed item." + } + ] }, { "name" : "getRange", @@ -108636,7 +295151,37 @@ "desc" : "Returns a range of items in this collection", "sig" : "(startIndex, endIndex)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "startIndex", + "type" : "Number", + "desc" : "(optional) defaults to 0", + "isOptional" : false + }, + { + "name" : "endIndex", + "type" : "Number", + "desc" : "(optional) default to the last item", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "An array of items" + } + ] }, { "name" : "hasListener", @@ -108644,7 +295189,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "indexOf", @@ -108652,7 +295221,31 @@ "desc" : "Returns index within the collection of the passed Object.", "sig" : "(o)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "o", + "type" : "Object", + "desc" : "The item to find the index of.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "index of the item." + } + ] }, { "name" : "indexOfKey", @@ -108660,7 +295253,31 @@ "desc" : "Returns index within the collection of the passed key.", "sig" : "(key)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "key", + "type" : "String", + "desc" : "The key to find the index of.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "index of the key." + } + ] }, { "name" : "insert", @@ -108668,7 +295285,43 @@ "desc" : "Inserts an item at the specified index in the collection.", "sig" : "(index, key, o)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index to insert the item at.", + "isOptional" : false + }, + { + "name" : "key", + "type" : "String", + "desc" : "The key to associate with the new item, or the item itself.", + "isOptional" : false + }, + { + "name" : "o", + "type" : "Object", + "desc" : "(optional) If the second parameter was a key, the new item.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The item inserted." + } + ] }, { "name" : "item", @@ -108676,7 +295329,31 @@ "desc" : "Returns the item associated with the passed key OR index. Key has priority over index.", "sig" : "(key)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "key", + "type" : "String/Number", + "desc" : "The key or index of the item.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The item associated with the passed key." + } + ] }, { "name" : "itemAt", @@ -108684,7 +295361,31 @@ "desc" : "Returns the item at the specified index.", "sig" : "(index)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index of the item.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "" + } + ] }, { "name" : "key", @@ -108692,7 +295393,31 @@ "desc" : "Returns the item associated with the passed key.", "sig" : "(key)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "key", + "type" : "String/Number", + "desc" : "The key of the item.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The item associated with the passed key." + } + ] }, { "name" : "keySort", @@ -108700,7 +295425,31 @@ "desc" : "Sorts this collection by keys", "sig" : "(direction, fn)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "direction", + "type" : "String", + "desc" : "(optional) \"ASC\" or \"DESC\"", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "(optional) a comparison function (defaults to case insensitive string)", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "last", @@ -108708,7 +295457,24 @@ "desc" : "Returns the last item in the collection.", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "the last item in the collection.." + } + ] }, { "name" : "on", @@ -108716,7 +295482,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "purgeListeners", @@ -108724,7 +295526,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "Roo.util.Observable" + "memberOf" : "Roo.util.Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -108732,7 +295545,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "Roo.util.Observable" + "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" : "remove", @@ -108740,7 +295571,31 @@ "desc" : "Removed an item from the collection.", "sig" : "(o)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "o", + "type" : "Object", + "desc" : "The item to remove.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The item removed." + } + ] }, { "name" : "removeAt", @@ -108748,7 +295603,25 @@ "desc" : "Remove an item from a specified index in the collection.", "sig" : "(index)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "index", + "type" : "Number", + "desc" : "The index within the collection of the item to remove.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeKey", @@ -108756,7 +295629,25 @@ "desc" : "Removed an item associated with the passed key fom the collection.", "sig" : "(key)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "key", + "type" : "String", + "desc" : "The key of the item to remove.", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "removeListener", @@ -108764,7 +295655,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : "replace", @@ -108772,7 +295693,37 @@ "desc" : "Replaces an item in the collection.", "sig" : "(key, o)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "key", + "type" : "String", + "desc" : "The key associated with the item to replace, or the item to replace.", + "isOptional" : false + }, + { + "name" : "o", + "type" : "", + "desc" : "{Object} o (optional) If the first parameter passed was a key, the item to associate with that key.", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "The new item." + } + ] }, { "name" : "sort", @@ -108780,7 +295731,31 @@ "desc" : "Sorts this collection with the passed comparison function", "sig" : "(direction, fn)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "direction", + "type" : "String", + "desc" : "(optional) \"ASC\" or \"DESC\"", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "(optional) comparison function", + "isOptional" : false + } + ], + "returns" : [] }, { "name" : "un", @@ -108788,7 +295763,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "Roo.util.Observable" + "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" : [] } ] }, @@ -108809,7 +295814,25 @@ "desc" : "Used to define events on this Observable", "sig" : "(object)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "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" : "addListener", @@ -108817,7 +295840,43 @@ "desc" : "Appends an event handler to this component", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "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" : [] }, { "name" : "capture", @@ -108825,7 +295884,37 @@ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with 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" : "" + "memberOf" : "", + "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" : "fireEvent", @@ -108833,7 +295922,37 @@ "desc" : "Fires the specified event with the passed parameters (minus the event name).", "sig" : "(eventName, args)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "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", @@ -108841,7 +295960,31 @@ "desc" : "Checks to see if this object has any listeners for a specified event", "sig" : "(eventName)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "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" : "on", @@ -108849,7 +295992,43 @@ "desc" : "Appends an event handler to this element (shorthand for addListener)", "sig" : "(eventName, handler, scope, options)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "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" : "purgeListeners", @@ -108857,7 +296036,18 @@ "desc" : "Removes all listeners for this object", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "releaseCapture", @@ -108865,7 +296055,25 @@ "desc" : "Removes all added captures from the Observable.", "sig" : "(o)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "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", @@ -108873,7 +296081,37 @@ "desc" : "Removes a listener", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "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" : "un", @@ -108881,7 +296119,37 @@ "desc" : "Removes a listener (shorthand for removeListener)", "sig" : "(eventName, handler, scope)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "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" : [] } ] }, @@ -108895,7 +296163,37 @@ "desc" : "Return a unique TextMetrics instance that can be bound directly to an element and reused. This reduces\nthe overhead of multiple calls to initialize the style properties on each measurement.", "sig" : "(el, fixedWidth)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement", + "desc" : "The element, dom node or id that the instance will be bound to", + "isOptional" : false + }, + { + "name" : "fixedWidth", + "type" : "Number", + "desc" : "(optional) If the text will be multiline, you have to set a fixed width\nin order to accurately measure the text height", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Roo.util.TextMetrics.Instance", + "desc" : "instance The new instance" + } + ] }, { "name" : "measure", @@ -108903,7 +296201,43 @@ "desc" : "Measures the size of the specified text", "sig" : "(el, text, fixedWidth)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "el", + "type" : "String/HTMLElement", + "desc" : "The element, dom node or id from which to copy existing CSS styles\nthat can affect the size of the rendered text", + "isOptional" : false + }, + { + "name" : "text", + "type" : "String", + "desc" : "The text to measure", + "isOptional" : false + }, + { + "name" : "fixedWidth", + "type" : "Number", + "desc" : "(optional) If the text will be multiline, you have to set a fixed width\nin order to accurately measure the text height", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Object", + "desc" : "An object containing the text's size {width: (width), height: (height)}" + } + ] } ] }, @@ -108922,7 +296256,31 @@ "desc" : "Escapes the passed string for ' and \\", "sig" : "(string)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "string", + "type" : "String", + "desc" : "The string to escape", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The escaped string" + } + ] }, { "name" : "format", @@ -108930,7 +296288,43 @@ "desc" : "Allows you to define a tokenized string and pass an arbitrary number of arguments to replace the tokens. Each\ntoken must be unique, and must increment in the format {0}, {1}, etc. Example usage:\n
\nvar cls = 'my-class', text = 'Some text';\nvar s = String.format('
{1}
', cls, text);\n// s now contains the string: '
Some text
'\n
", "sig" : "(string, value1, value2)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "string", + "type" : "String", + "desc" : "The tokenized string to be formatted", + "isOptional" : false + }, + { + "name" : "value1", + "type" : "String", + "desc" : "The value to replace token {0}", + "isOptional" : false + }, + { + "name" : "value2", + "type" : "String", + "desc" : "Etc...", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The formatted string" + } + ] }, { "name" : "leftPad", @@ -108938,7 +296332,43 @@ "desc" : "Pads the left side of a string with a specified character. This is especially useful\nfor normalizing number and date strings. Example usage:\n
\nvar s = String.leftPad('123', 5, '0');\n// s now contains the string: '00123'\n
", "sig" : "(string, size, char)", "static" : true, - "memberOf" : "" + "memberOf" : "", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "string", + "type" : "String", + "desc" : "The original string", + "isOptional" : false + }, + { + "name" : "size", + "type" : "Number", + "desc" : "The total length of the output string", + "isOptional" : false + }, + { + "name" : "char", + "type" : "String", + "desc" : "(optional) The character with which to pad the original string (defaults to empty string \" \")", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The padded string" + } + ] }, { "name" : "toggle", @@ -108946,7 +296376,37 @@ "desc" : "Utility function that allows you to easily switch a string between two alternating values. The passed value\nis compared to the current string, and if they are equal, the other value that was passed in is returned. If\nthey are already different, the first value passed in is returned. Note that this method returns the new value\nbut does not change the current string.\n
\n// alternate sort directions\nsort = sort.toggle('ASC', 'DESC');\n\n// instead of conditional logic:\nsort = (sort == 'ASC' ? 'DESC' : 'ASC');\n
", "sig" : "(value, other)", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "value", + "type" : "String", + "desc" : "The value to compare to the current string", + "isOptional" : false + }, + { + "name" : "other", + "type" : "String", + "desc" : "The new value to use if the string already equals the first value passed in", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The new value" + } + ] }, { "name" : "unicodeClean", @@ -108954,7 +296414,24 @@ "desc" : "Remove invalid unicode characters from a string", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [ + { + "name" : "", + "type" : "String", + "desc" : "The clean string" + } + ] } ] }, @@ -108968,7 +296445,18 @@ "desc" : "Inline Lexer & Compiler", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "Lexer", @@ -108976,7 +296464,18 @@ "desc" : "Block Lexer", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "Parser", @@ -108984,7 +296483,18 @@ "desc" : "eval:var:Parser", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "Renderer", @@ -108992,7 +296502,18 @@ "desc" : "eval:var:Renderer", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "escape", @@ -109000,7 +296521,18 @@ "desc" : "Helpers", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "marked", @@ -109008,7 +296540,18 @@ "desc" : "eval:var:marked", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "merge", @@ -109016,7 +296559,18 @@ "desc" : "eval:var:merge", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "noop", @@ -109024,7 +296578,18 @@ "desc" : "eval:var:noop", "sig" : "()\n{\n\n}", "static" : false, - "memberOf" : "" + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] } ] }, diff --git a/docs/src/Roo_BasicDialog.js.html b/docs/src/Roo_BasicDialog.js.html index cd435b45ab..720fa1d361 100644 --- a/docs/src/Roo_BasicDialog.js.html +++ b/docs/src/Roo_BasicDialog.js.html @@ -1117,139 +1117,4 @@ dlg.show(); } }; }(); - -/** - * @class Roo.LayoutDialog - * @extends Roo.BasicDialog - * Dialog which provides adjustments for working with a layout in a Dialog. - * Add your necessary layout config options to the dialog's config.<br> - * Example usage (including a nested layout): - * <pre><code> -if(!dialog){ - dialog = new Roo.LayoutDialog("download-dlg", { - modal: true, - width:600, - height:450, - shadow:true, - minWidth:500, - minHeight:350, - autoTabs:true, - proxyDrag:true, - // layout config merges with the dialog config - center:{ - tabPosition: "top", - alwaysShowTabs: true - } - }); - dialog.addKeyListener(27, dialog.hide, dialog); - dialog.setDefaultButton(dialog.addButton("Close", dialog.hide, dialog)); - dialog.addButton("Build It!", this.getDownload, this); - - // we can even add nested layouts - var innerLayout = new Roo.BorderLayout("dl-inner", { - east: { - initialSize: 200, - autoScroll:true, - split:true - }, - center: { - autoScroll:true - } - }); - innerLayout.beginUpdate(); - innerLayout.add("east", new Roo.ContentPanel("dl-details")); - innerLayout.add("center", new Roo.ContentPanel("selection-panel")); - innerLayout.endUpdate(true); - - var layout = dialog.getLayout(); - layout.beginUpdate(); - layout.add("center", new Roo.ContentPanel("standard-panel", - {title: "Download the Source", fitToFrame:true})); - layout.add("center", new Roo.NestedLayoutPanel(innerLayout, - {title: "Build your own roo.js"})); - layout.getRegion("center").showPanel(sp); - layout.endUpdate(); -} -</code></pre> - * @constructor - * @param {String/HTMLElement/Roo.Element} el The id of or container element, or config - * @param {Object} config configuration options - */ -Roo.LayoutDialog = function(el, cfg){ - - var config= cfg; - if (typeof(cfg) == 'undefined') { - config = Roo.apply({}, el); - // not sure why we use documentElement here.. - it should always be body. - // IE7 borks horribly if we use documentElement. - // webkit also does not like documentElement - it creates a body element... - el = Roo.get( document.body || document.documentElement ).createChild(); - //config.autoCreate = true; - } - - - config.autoTabs = false; - Roo.LayoutDialog.superclass.constructor.call(this, el, config); - this.body.setStyle({overflow:"hidden", position:"relative"}); - this.layout = new Roo.BorderLayout(this.body.dom, config); - this.layout.monitorWindowResize = false; - this.el.addClass("x-dlg-auto-layout"); - // fix case when center region overwrites center function - this.center = Roo.BasicDialog.prototype.center; - this.on("show", this.layout.layout, this.layout, true); - if (config.items) { - var xitems = config.items; - delete config.items; - Roo.each(xitems, this.addxtype, this); - } - - -}; -Roo.extend(Roo.LayoutDialog, Roo.BasicDialog, { - /** - * Ends update of the layout <strike>and resets display to none</strike>. Use standard beginUpdate/endUpdate on the layout. - * @deprecated - */ - endUpdate : function(){ - this.layout.endUpdate(); - }, - - /** - * Begins an update of the layout <strike>and sets display to block and visibility to hidden</strike>. Use standard beginUpdate/endUpdate on the layout. - * @deprecated - */ - beginUpdate : function(){ - this.layout.beginUpdate(); - }, - - /** - * Get the BorderLayout for this dialog - * @return {Roo.BorderLayout} - */ - getLayout : function(){ - return this.layout; - }, - - showEl : function(){ - Roo.LayoutDialog.superclass.showEl.apply(this, arguments); - if(Roo.isIE7){ - this.layout.layout(); - } - }, - - // private - // Use the syncHeightBeforeShow config option to control this automatically - syncBodyHeight : function(){ - Roo.LayoutDialog.superclass.syncBodyHeight.call(this); - if(this.layout){this.layout.layout();} - }, - - /** - * Add an xtype element (actually adds to the layout.) - * @return {Object} xdata xtype object data. - */ - - addxtype : function(c) { - return this.layout.addxtype(c); - } -}); \ No newline at end of file + \ No newline at end of file diff --git a/docs/src/Roo_BorderLayout.js.html b/docs/src/Roo_BorderLayout.js.html index c3acf51d4c..b7e7769ae9 100644 --- a/docs/src/Roo_BorderLayout.js.html +++ b/docs/src/Roo_BorderLayout.js.html @@ -11,6 +11,7 @@ /** * @class Roo.BorderLayout * @extends Roo.LayoutManager + * @children Roo.ContentPanel * This class represents a common layout manager used in desktop applications. For screenshots and more details, * please see: <br><br> * <a href="http://www.jackslocum.com/yui/2006/10/19/cross-browser-web-20-layouts-with-yahoo-ui/">Cross Browser Layouts - Part 1</a><br> @@ -92,7 +93,23 @@ the container size if it is not the body element.</b> }; Roo.extend(Roo.BorderLayout, Roo.LayoutManager, { - /** + + /** + * @cfg {Roo.LayoutRegion} east + */ + /** + * @cfg {Roo.LayoutRegion} west + */ + /** + * @cfg {Roo.LayoutRegion} north + */ + /** + * @cfg {Roo.LayoutRegion} south + */ + /** + * @cfg {Roo.LayoutRegion} center + */ + /** * Creates and adds a new region if it doesn't already exist. * @param {String} target The target region key (north, south, east, west or center). * @param {Object} config The regions config object diff --git a/docs/src/Roo_Button.js.html b/docs/src/Roo_Button.js.html index 6bd21f4bbf..cb40668362 100644 --- a/docs/src/Roo_Button.js.html +++ b/docs/src/Roo_Button.js.html @@ -121,7 +121,7 @@ */ enableToggle: false, /** - * @cfg {Mixed} menu + * @cfg {Roo.menu.Menu} menu * Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined). */ menu : undefined, diff --git a/docs/src/Roo_ContentPanel.js.html b/docs/src/Roo_ContentPanel.js.html index f5fb6bd07c..fef05550c2 100644 --- a/docs/src/Roo_ContentPanel.js.html +++ b/docs/src/Roo_ContentPanel.js.html @@ -11,23 +11,26 @@ /** * @class Roo.ContentPanel * @extends Roo.util.Observable + * @children Roo.form.Form Roo.JsonView Roo.View + * @builder-top * A basic ContentPanel element. * @cfg {Boolean} fitToFrame True for this panel to adjust its size to fit when the region resizes (defaults to false) * @cfg {Boolean} fitContainer When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false) - * @cfg {Boolean/Object} autoCreate True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create + * @cfg {Boolean|Object} autoCreate True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create * @cfg {Boolean} closable True if the panel can be closed/removed * @cfg {Boolean} background True if the panel should not be activated when it is added (defaults to false) - * @cfg {String/HTMLElement/Element} resizeEl An element to resize if {@link #fitToFrame} is true (instead of this panel's element) - * @cfg {Toolbar} toolbar A toolbar for this panel + * @cfg {String|HTMLElement|Element} resizeEl An element to resize if {@link #fitToFrame} is true (instead of this panel's element) + * @cfg {Roo.Toolbar} toolbar A toolbar for this panel * @cfg {Boolean} autoScroll True to scroll overflow in this panel (use with {@link #fitToFrame}) * @cfg {String} title The title for this panel * @cfg {Array} adjustments Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0]) * @cfg {String} url Calls {@link #setUrl} with this value - * @cfg {String} region (center|north|south|east|west) which region to put this panel on (when used with xtype constructors) - * @cfg {String/Object} params When used with {@link #url}, calls {@link #setUrl} with this value + * @cfg {String} region [required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors) + * @cfg {String|Object} params When used with {@link #url}, calls {@link #setUrl} with this value * @cfg {Boolean} loadOnce When used with {@link #url}, calls {@link #setUrl} with this value * @cfg {String} content Raw content to fill content panel with (uses setContent on construction.) - * @cfg {String} style Extra style to add to the content panel + * @cfg {String} style Extra style to add to the content panel + * @cfg {Roo.menu.Menu} menu popup menu * @constructor * Create a new ContentPanel. @@ -539,7 +542,7 @@ layout.addxtype({ * Create a new NestedLayoutPanel. * * - * @param {Roo.BorderLayout} layout The layout for this panel + * @param {Roo.BorderLayout} layout [required] The layout for this panel * @param {String/Object} config A string to set only the title or a config object */ Roo.NestedLayoutPanel = function(layout, config) @@ -772,7 +775,7 @@ panel.addxtype({ fitToFrame : true, autoScroll : true, /* - * @cfg {Roo.tree.TreePanel} tree The tree TreePanel, with config etc. + * @cfg {Roo.tree.TreePanel} tree [required] The tree TreePanel, with config etc. */ tree : false diff --git a/docs/src/Roo_PagingToolbar.js.html b/docs/src/Roo_PagingToolbar.js.html index ad87006592..c3581d2010 100644 --- a/docs/src/Roo_PagingToolbar.js.html +++ b/docs/src/Roo_PagingToolbar.js.html @@ -12,6 +12,7 @@ /** * @class Roo.PagingToolbar * @extends Roo.Toolbar + * @children Roo.Toolbar.Item Roo.form.Field * A specialized toolbar that is bound to a {@link Roo.data.Store} and provides automatic paging controls. * @constructor * Create a new PagingToolbar diff --git a/docs/src/Roo_Toolbar.js.html b/docs/src/Roo_Toolbar.js.html index a2e08e837d..e6be5f174f 100644 --- a/docs/src/Roo_Toolbar.js.html +++ b/docs/src/Roo_Toolbar.js.html @@ -11,6 +11,7 @@ /** * @class Roo.Toolbar + * @children Roo.Toolbar.Item Roo.form.Field * Basic Toolbar class. * @constructor * Creates a new Toolbar @@ -560,7 +561,10 @@ Roo.Toolbar.Button = function(config){ Roo.Toolbar.Button.superclass.constructor.call(this, null, config); }; -Roo.extend(Roo.Toolbar.Button, Roo.Button, { +Roo.extend(Roo.Toolbar.Button, Roo.Button, +{ + + render : function(td){ this.td = td; Roo.Toolbar.Button.superclass.render.call(this, td); diff --git a/docs/src/Roo_bootstrap_Body.js.html b/docs/src/Roo_bootstrap_Body.js.html index 895a55f154..f2dfb7beab 100644 --- a/docs/src/Roo_bootstrap_Body.js.html +++ b/docs/src/Roo_bootstrap_Body.js.html @@ -8,6 +8,9 @@ /** * @class Roo.bootstrap.Body * @extends Roo.bootstrap.Component + * @builder-top + * @children Roo.bootstrap.Component + * @parent none * Bootstrap Body class * * @constructor diff --git a/docs/src/Roo_bootstrap_Calendar.js.html b/docs/src/Roo_bootstrap_Calendar.js.html index e622508831..56d77e80a7 100644 --- a/docs/src/Roo_bootstrap_Calendar.js.html +++ b/docs/src/Roo_bootstrap_Calendar.js.html @@ -65,6 +65,11 @@ Roo.extend(Roo.bootstrap.Calendar, Roo.bootstrap.Component, { + /** + * @cfg {Roo.data.Store} store + * The data source for the calendar + */ + store : false, /** * @cfg {Number} startDay * Day index at which the week should begin, 0-based (defaults to 0, which is Sunday) diff --git a/docs/src/Roo_bootstrap_Card.js.html b/docs/src/Roo_bootstrap_Card.js.html index 1ef63da5a5..b8416b78b4 100644 --- a/docs/src/Roo_bootstrap_Card.js.html +++ b/docs/src/Roo_bootstrap_Card.js.html @@ -7,6 +7,7 @@ /** * @class Roo.bootstrap.Card * @extends Roo.bootstrap.Component + * @children Roo.bootstrap.Component * Bootstrap Card class * * diff --git a/docs/src/Roo_bootstrap_Column.js.html b/docs/src/Roo_bootstrap_Column.js.html index 05b9f4cf9d..a0c00d3b48 100644 --- a/docs/src/Roo_bootstrap_Column.js.html +++ b/docs/src/Roo_bootstrap_Column.js.html @@ -8,6 +8,7 @@ /** * @class Roo.bootstrap.Column * @extends Roo.bootstrap.Component + * @children Roo.bootstrap.Component * Bootstrap Column class * @cfg {Number} xs colspan out of 12 for mobile-sized screens or 0 for hidden * @cfg {Number} sm colspan out of 12 for tablet-sized screens or 0 for hidden diff --git a/docs/src/Roo_bootstrap_Component.js.html b/docs/src/Roo_bootstrap_Component.js.html index 9ecd78d3ec..d4636f258f 100644 --- a/docs/src/Roo_bootstrap_Component.js.html +++ b/docs/src/Roo_bootstrap_Component.js.html @@ -9,6 +9,8 @@ /** * @class Roo.bootstrap.Component * @extends Roo.Component + * @abstract + * @children Roo.bootstrap.Component * Bootstrap Component base class * @cfg {String} cls css class * @cfg {String} style any extra css diff --git a/docs/src/Roo_bootstrap_Container.js.html b/docs/src/Roo_bootstrap_Container.js.html index 5b21a94227..947e460d34 100644 --- a/docs/src/Roo_bootstrap_Container.js.html +++ b/docs/src/Roo_bootstrap_Container.js.html @@ -9,6 +9,8 @@ /** * @class Roo.bootstrap.Container * @extends Roo.bootstrap.Component + * @builder-top + * @children Roo.bootstrap.Component * Bootstrap Container class * @cfg {Boolean} jumbotron is it a jumbotron element * @cfg {String} html content of element diff --git a/docs/src/Roo_bootstrap_Element.js.html b/docs/src/Roo_bootstrap_Element.js.html index 0644ada6c9..9f5b6729bd 100644 --- a/docs/src/Roo_bootstrap_Element.js.html +++ b/docs/src/Roo_bootstrap_Element.js.html @@ -8,7 +8,9 @@ /** * @class Roo.bootstrap.Element * @extends Roo.bootstrap.Component - * Bootstrap Element class + * @children Roo.bootstrap.Component + * Bootstrap Element class (basically a DIV used to make random stuff ) + * * @cfg {String} html contents of the element * @cfg {String} tag tag of the element * @cfg {String} cls class of the element diff --git a/docs/src/Roo_bootstrap_Form.js.html b/docs/src/Roo_bootstrap_Form.js.html index 2d224ea1a0..9be468310d 100644 --- a/docs/src/Roo_bootstrap_Form.js.html +++ b/docs/src/Roo_bootstrap_Form.js.html @@ -8,6 +8,7 @@ /** * @class Roo.bootstrap.Form * @extends Roo.bootstrap.Component + * @children Roo.bootstrap.Component * Bootstrap Form class * @cfg {String} method GET | POST (default POST) * @cfg {String} labelAlign top | left (default top) diff --git a/docs/src/Roo_bootstrap_Link.js.html b/docs/src/Roo_bootstrap_Link.js.html index 80e58b22a1..ff0e106284 100644 --- a/docs/src/Roo_bootstrap_Link.js.html +++ b/docs/src/Roo_bootstrap_Link.js.html @@ -9,7 +9,9 @@ /** * @class Roo.bootstrap.Link * @extends Roo.bootstrap.Component - * Bootstrap Link Class + * @children Roo.bootstrap.Component + * Bootstrap Link Class (eg. '<a href>') + * @cfg {String} alt image alternative text * @cfg {String} href a tag href * @cfg {String} target (_self|_blank|_parent|_top) target for a href. diff --git a/docs/src/Roo_bootstrap_Modal.js.html b/docs/src/Roo_bootstrap_Modal.js.html index 913e550288..3a8a350f72 100644 --- a/docs/src/Roo_bootstrap_Modal.js.html +++ b/docs/src/Roo_bootstrap_Modal.js.html @@ -6,6 +6,9 @@ /** * @class Roo.bootstrap.Modal * @extends Roo.bootstrap.Component + * @builder-top + * @parent none + * @children Roo.bootstrap.Component * Bootstrap Modal class * @cfg {String} title Title of dialog * @cfg {String} html - the body of the dialog (for simple ones) - you can also use template.. diff --git a/docs/src/Roo_bootstrap_PhoneInput.js.html b/docs/src/Roo_bootstrap_PhoneInput.js.html index c679cac6e2..5b4301a24b 100644 --- a/docs/src/Roo_bootstrap_PhoneInput.js.html +++ b/docs/src/Roo_bootstrap_PhoneInput.js.html @@ -24,7 +24,9 @@ }; Roo.extend(Roo.bootstrap.PhoneInput, Roo.bootstrap.TriggerField, { - + /** + * @cfg {Roo.data.Store} store [required] The data store to which this combo is bound (defaults to undefined) + */ listWidth: undefined, selectedClass: 'active', diff --git a/docs/src/Roo_bootstrap_Popover.js.html b/docs/src/Roo_bootstrap_Popover.js.html index a0a4f7dd2f..19038234b2 100644 --- a/docs/src/Roo_bootstrap_Popover.js.html +++ b/docs/src/Roo_bootstrap_Popover.js.html @@ -8,6 +8,8 @@ /** * @class Roo.bootstrap.Popover * @extends Roo.bootstrap.Component + * @builder-top + * @children Roo.bootstrap.Component * Bootstrap Popover class * @cfg {String} html contents of the popover (or false to use children..) * @cfg {String} title of popover (or false to hide) diff --git a/docs/src/Roo_bootstrap_Row.js.html b/docs/src/Roo_bootstrap_Row.js.html index d486712f40..dc6cf8f749 100644 --- a/docs/src/Roo_bootstrap_Row.js.html +++ b/docs/src/Roo_bootstrap_Row.js.html @@ -8,6 +8,7 @@ /** * @class Roo.bootstrap.Row * @extends Roo.bootstrap.Component + * @children Roo.bootstrap.Component * Bootstrap Row class (contains columns...) * * @constructor diff --git a/docs/src/Roo_bootstrap_TabPanel.js.html b/docs/src/Roo_bootstrap_TabPanel.js.html index 2f1bbe1766..c23839bfdb 100644 --- a/docs/src/Roo_bootstrap_TabPanel.js.html +++ b/docs/src/Roo_bootstrap_TabPanel.js.html @@ -8,6 +8,7 @@ /** * @class Roo.bootstrap.TabPanel * @extends Roo.bootstrap.Component + * @children Roo.bootstrap.Component * Bootstrap TabPanel class * @cfg {Boolean} active panel active * @cfg {String} html panel content diff --git a/docs/src/Roo_bootstrap_Table.js.html b/docs/src/Roo_bootstrap_Table.js.html index efd4d9707f..07e3c74509 100644 --- a/docs/src/Roo_bootstrap_Table.js.html +++ b/docs/src/Roo_bootstrap_Table.js.html @@ -63,8 +63,8 @@ Currently the Table uses multiple headers to try and handle XL / Medium etc... * - * @cfg {Roo.grid.RowSelectionModel|Roo.grid.CellSelectionModel} sm The selection model to use (cell selection is not supported yet) - * @cfg {Roo.data.Store|Roo.data.SimpleStore} store The data store to use + * @cfg {Roo.grid.AbstractSelectionModel} sm The selection model to use (cell selection is not supported yet) + * @cfg {Roo.data.Store} store The data store to use * @cfg {Roo.grid.ColumnModel} cm[] A column for th grid. * * @cfg {String} cls table class diff --git a/docs/src/Roo_bootstrap_layout_Border.js.html b/docs/src/Roo_bootstrap_layout_Border.js.html index 9647fe48aa..afc72d1d8d 100644 --- a/docs/src/Roo_bootstrap_layout_Border.js.html +++ b/docs/src/Roo_bootstrap_layout_Border.js.html @@ -11,6 +11,7 @@ /** * @class Roo.bootstrap.layout.Border * @extends Roo.bootstrap.layout.Manager + * @builder-top * This class represents a common layout manager used in desktop applications. For screenshots and more details, * please see: examples/bootstrap/nested.html<br><br> diff --git a/docs/src/Roo_bootstrap_panel_Content.js.html b/docs/src/Roo_bootstrap_panel_Content.js.html index 159500c6dd..97b37ed96f 100644 --- a/docs/src/Roo_bootstrap_panel_Content.js.html +++ b/docs/src/Roo_bootstrap_panel_Content.js.html @@ -9,9 +9,11 @@ * <script type="text/javascript"> */ /** - * @class Roo.ContentPanel + * @class Roo.bootstrap.paenl.Content * @extends Roo.util.Observable - * A basic ContentPanel element. + * @builder-top + * @children Roo.bootstrap.Component + * A basic ContentPanel element. - a panel that contain any content (eg. forms etc.) * @cfg {Boolean} fitToFrame True for this panel to adjust its size to fit when the region resizes (defaults to false) * @cfg {Boolean} fitContainer When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false) * @cfg {Boolean/Object} autoCreate True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create @@ -31,7 +33,7 @@ * @cfg {Boolean} badges render the badges * @cfg {String} cls extra classes to use * @cfg {String} background (primary|secondary|success|info|warning|danger|light|dark) - + * @constructor * Create a new ContentPanel. * @param {String/HTMLElement/Roo.Element} el The container element for this panel diff --git a/docs/src/Roo_data_DataProxy.js.html b/docs/src/Roo_data_DataProxy.js.html index e0d1aa1142..c9c65b0ea3 100644 --- a/docs/src/Roo_data_DataProxy.js.html +++ b/docs/src/Roo_data_DataProxy.js.html @@ -12,6 +12,7 @@ /** * @class Roo.data.DataProxy * @extends Roo.data.Observable + * @abstract * This class is an abstract base class for implementations which provide retrieval of * unformatted data objects.<br> * <p> diff --git a/docs/src/Roo_data_DataReader.js.html b/docs/src/Roo_data_DataReader.js.html index c1e6247063..11aa0be800 100644 --- a/docs/src/Roo_data_DataReader.js.html +++ b/docs/src/Roo_data_DataReader.js.html @@ -14,6 +14,7 @@ /** * @class Roo.data.DataReader + * @abstract * Base class for reading structured data from a data source. This class is intended to be * extended (see {Roo.data.ArrayReader}, {Roo.data.JsonReader} and {Roo.data.XmlReader}) and should not be created directly. */ diff --git a/docs/src/Roo_data_SimpleStore.js.html b/docs/src/Roo_data_SimpleStore.js.html index 6cb65f6380..a91ba6e274 100644 --- a/docs/src/Roo_data_SimpleStore.js.html +++ b/docs/src/Roo_data_SimpleStore.js.html @@ -17,6 +17,8 @@ * @cfg {Array} fields An array of field definition objects, or field name strings. * @cfg {Object} an existing reader (eg. copied from another store) * @cfg {Array} data The multi-dimensional array of data + * @cfg {Roo.data.DataProxy} proxy [not-required] + * @cfg {Roo.data.Reader} reader [not-required] * @constructor * @param {Object} config */ diff --git a/docs/src/Roo_data_Store.js.html b/docs/src/Roo_data_Store.js.html index 87793a74bd..1b20d5347f 100644 --- a/docs/src/Roo_data_Store.js.html +++ b/docs/src/Roo_data_Store.js.html @@ -177,13 +177,13 @@ */ /** - * @cfg {Roo.data.DataProxy} proxy The Proxy object which provides access to a data object. + * @cfg {Roo.data.DataProxy} proxy [required] The Proxy object which provides access to a data object. */ /** * @cfg {Array} data Inline data to be loaded when the store is initialized. */ /** - * @cfg {Roo.data.Reader} reader The Reader object which processes the data object and returns + * @cfg {Roo.data.DataReader} reader [required] The Reader object which processes the data object and returns * an Array of Roo.data.record objects which are cached keyed by their <em>id</em> property. */ /** diff --git a/docs/src/Roo_form_ComboBoxArray.js.html b/docs/src/Roo_form_ComboBoxArray.js.html index 3eaf9911e8..da1bac488c 100644 --- a/docs/src/Roo_form_ComboBoxArray.js.html +++ b/docs/src/Roo_form_ComboBoxArray.js.html @@ -72,7 +72,7 @@ Roo.extend(Roo.form.ComboBoxArray, Roo.form.TextField, { /** - * @cfg {Roo.form.Combo} combo The combo box that is wrapped + * @cfg {Roo.form.ComboBox} combo [required] The combo box that is wrapped */ lastData : false, diff --git a/docs/src/Roo_form_Form.js.html b/docs/src/Roo_form_Form.js.html index 4d210042f7..70f5af7f34 100644 --- a/docs/src/Roo_form_Form.js.html +++ b/docs/src/Roo_form_Form.js.html @@ -12,6 +12,7 @@ /** * @class Roo.form.Form * @extends Roo.form.BasicForm + * @children Roo.form.Column Roo.form.FieldSet Roo.form.Row Roo.form.Field Roo.Button Roo.form.TextItem * Adds the ability to dynamically render forms with JavaScript to {@link Roo.form.BasicForm}. * @constructor * @param {Object} config Configuration options @@ -69,7 +70,11 @@ }; Roo.extend(Roo.form.Form, Roo.form.BasicForm, { - /** + /** + * @cfg {Roo.Button} buttons[] buttons at bottom of form + */ + + /** * @cfg {Number} labelWidth The width of labels. This property cascades to child containers. */ /** diff --git a/docs/src/Roo_form_Layout.js.html b/docs/src/Roo_form_Layout.js.html index 322a13bc86..bbff9f4011 100644 --- a/docs/src/Roo_form_Layout.js.html +++ b/docs/src/Roo_form_Layout.js.html @@ -12,6 +12,7 @@ /** * @class Roo.form.Layout * @extends Roo.Component + * @children Roo.form.Column Roo.form.Row Roo.form.Field Roo.Button Roo.form.TextItem * Creates a container for layout and rendering of fields in an {@link Roo.form.Form}. * @constructor * @param {Object} config Configuration options @@ -196,6 +197,7 @@ /** * @class Roo.form.Row * @extends Roo.form.Layout + * @children Roo.form.Column Roo.form.Row Roo.form.Field Roo.Button Roo.form.TextItem * Creates a row container for layout and rendering of fields in an {@link Roo.form.Form}. * @constructor * @param {Object} config Configuration options @@ -272,6 +274,7 @@ /** * @class Roo.form.FieldSet * @extends Roo.form.Layout + * @children Roo.form.Column Roo.form.Row Roo.form.Field Roo.Button Roo.form.TextItem * Creates a fieldset container for layout and rendering of fields in an {@link Roo.form.Form}. * @constructor * @param {Object} config Configuration options diff --git a/docs/src/Roo_grid_AbstractGridView.js.html b/docs/src/Roo_grid_AbstractGridView.js.html index 1be166d9ef..53e1a8eb71 100644 --- a/docs/src/Roo_grid_AbstractGridView.js.html +++ b/docs/src/Roo_grid_AbstractGridView.js.html @@ -8,7 +8,13 @@ * Fork - LGPL * <script type="text/javascript"> */ - + /** + * @class Roo.grid.AbstractGridView + * @extends Roo.util.Observable + * @abstract + * Abstract base class for grid Views + * @constructor + */ Roo.grid.AbstractGridView = function(){ this.grid = null; diff --git a/docs/src/Roo_grid_AbstractSelectionModel.js.html b/docs/src/Roo_grid_AbstractSelectionModel.js.html index a83f1bb9d6..0abe890e11 100644 --- a/docs/src/Roo_grid_AbstractSelectionModel.js.html +++ b/docs/src/Roo_grid_AbstractSelectionModel.js.html @@ -12,6 +12,7 @@ /** * @class Roo.grid.AbstractSelectionModel * @extends Roo.util.Observable + * @abstract * Abstract base class for grid SelectionModels. It provides the interface that should be * implemented by descendant classes. This class should not be directly instantiated. * @constructor diff --git a/docs/src/Roo_grid_Grid.js.html b/docs/src/Roo_grid_Grid.js.html index f9aca01837..91c5891735 100644 --- a/docs/src/Roo_grid_Grid.js.html +++ b/docs/src/Roo_grid_Grid.js.html @@ -318,6 +318,21 @@ Roo.extend(Roo.grid.Grid, Roo.util.Observable, { /** + * @cfg {Roo.grid.AbstractSelectionModel} sm The selection Model (default = Roo.grid.RowSelectionModel) + */ + /** + * @cfg {Roo.grid.GridView} view The view that renders the grid (default = Roo.grid.GridView) + */ + /** + * @cfg {Roo.grid.ColumnModel} cm[] The columns of the grid + */ + /** + * @cfg {Roo.grid.Store} ds The data store for the grid + */ + /** + * @cfg {Roo.Toolbar} toolbar a toolbar for buttons etc. + */ + /** * @cfg {String} ddGroup - drag drop group. */ /** diff --git a/docs/src/Roo_menu_Adapter.js.html b/docs/src/Roo_menu_Adapter.js.html index e47a6eebf0..783cead2bb 100644 --- a/docs/src/Roo_menu_Adapter.js.html +++ b/docs/src/Roo_menu_Adapter.js.html @@ -12,6 +12,7 @@ /** * @class Roo.menu.Adapter * @extends Roo.menu.BaseItem + * @abstract * A base utility class that adapts a non-menu component so that it can be wrapped by a menu item and added to a menu. * It provides basic rendering, activation management and enable/disable logic required to work in menus. * @constructor diff --git a/docs/src/Roo_menu_BaseItem.js.html b/docs/src/Roo_menu_BaseItem.js.html index 85c3b4471c..43e6cee20a 100644 --- a/docs/src/Roo_menu_BaseItem.js.html +++ b/docs/src/Roo_menu_BaseItem.js.html @@ -13,6 +13,7 @@ /** * @class Roo.menu.BaseItem * @extends Roo.Component + * @abstract * The base class for all items that render into menus. BaseItem provides default rendering, activated state * management and base configuration options shared by all menu components. * @constructor diff --git a/docs/src/Roo_menu_Item.js.html b/docs/src/Roo_menu_Item.js.html index 569c7e7103..e461294f28 100644 --- a/docs/src/Roo_menu_Item.js.html +++ b/docs/src/Roo_menu_Item.js.html @@ -25,8 +25,11 @@ } }; Roo.extend(Roo.menu.Item, Roo.menu.BaseItem, { - /** + * @cfg {Roo.menu.Menu} menu + * A Sub menu + */ + /** * @cfg {String} text * The text to show on the menu item. */ diff --git a/docs/src/Roo_menu_Menu.js.html b/docs/src/Roo_menu_Menu.js.html index 3d684b1f01..0804539bb9 100644 --- a/docs/src/Roo_menu_Menu.js.html +++ b/docs/src/Roo_menu_Menu.js.html @@ -12,6 +12,7 @@ /** * @class Roo.menu.Menu * @extends Roo.util.Observable + * @children Roo.menu.BaseItem * A menu object. This is the container to which you add all other menu items. Menu can also serve a as a base class * when you want a specialzed menu based off of another component (like {@link Roo.menu.DateMenu} for example). * @constructor diff --git a/docs/src/Roo_tree_TreeEditor.js.html b/docs/src/Roo_tree_TreeEditor.js.html index 69fd919527..7ed147d16c 100644 --- a/docs/src/Roo_tree_TreeEditor.js.html +++ b/docs/src/Roo_tree_TreeEditor.js.html @@ -18,7 +18,7 @@ * @param {Object} oldconfig DEPRECIATED Either a prebuilt {@link Roo.form.Field} instance or a Field config object * * @cfg {Roo.tree.TreePanel} tree The tree to bind to. - * @cfg {Roo.form.TextField|Object} field The field configuration + * @cfg {Roo.form.TextField} field [required] The field configuration * * */ diff --git a/docs/src/Roo_tree_TreePanel.js.html b/docs/src/Roo_tree_TreePanel.js.html index 5fee48742a..8b3cb4036b 100644 --- a/docs/src/Roo_tree_TreePanel.js.html +++ b/docs/src/Roo_tree_TreePanel.js.html @@ -13,7 +13,7 @@ /** * @class Roo.tree.TreePanel * @extends Roo.data.Tree - + * @cfg {Roo.tree.TreeNode} root The root node * @cfg {Boolean} rootVisible false to hide the root node (defaults to true) * @cfg {Boolean} lines false to disable tree lines (defaults to true) * @cfg {Boolean} enableDD true to enable drag and drop @@ -30,8 +30,8 @@ * @cfg {Boolean} animate true to enable animated expand/collapse (defaults to the value of Roo.enableFx) * @cfg {Boolean} singleExpand true if only 1 node per branch may be expanded * @cfg {Boolean} selModel A tree selection model to use with this TreePanel (defaults to a {@link Roo.tree.DefaultSelectionModel}) - * @cfg {Boolean} loader A TreeLoader for use with this TreePanel - * @cfg {Object|Roo.tree.TreeEditor} editor The TreeEditor or xtype data to display when clicked. + * @cfg {Roo.tree.TreeLoader} loader A TreeLoader for use with this TreePanel + * @cfg {Roo.tree.TreeEditor} editor The TreeEditor to display when clicked. * @cfg {String} pathSeparator The token used to separate sub-paths in path strings (defaults to '/') * @cfg {Function} renderer DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes. to return HTML markup for the tree view. The render function is called with the following parameters:<ul><li>The {Object} The data for the node.</li></ul> * @cfg {Function} rendererTip DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes hovertip to return HTML markup for the tree view. The render function is called with the following parameters:<ul><li>The {Object} The data for the node.</li></ul> diff --git a/docs/symbols/Array.json b/docs/symbols/Array.json index eefa2f5745..df9660efb0 100644 --- a/docs/symbols/Array.json +++ b/docs/symbols/Array.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "indexOf", + "type" : "function", "desc" : "Checks whether or not the specified object exists in the array.", + "sig" : "(o)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Array", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -43,15 +50,20 @@ }, { "name" : "map", + "type" : "function", "desc" : "Map (JS 1.6 compatibility)", + "sig" : "(function() {\n\n})", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Array", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "function", @@ -64,15 +76,20 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Removes the specified object from the array. If the object is not found nothing happens.", + "sig" : "(o)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Array", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -85,15 +102,20 @@ }, { "name" : "equals", + "type" : "function", "desc" : "equals", + "sig" : "(o)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Array", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", diff --git a/docs/symbols/Date.json b/docs/symbols/Date.json index b0927b8341..84f8eed0e3 100644 --- a/docs/symbols/Date.json +++ b/docs/symbols/Date.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "getDayOfYear", + "type" : "function", "desc" : "Get the numeric day number of the year, adjusted for leap year.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Date", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -36,15 +43,20 @@ }, { "name" : "getFirstDateOfMonth", + "type" : "function", "desc" : "Get the first date of this date's month", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Date", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -56,15 +68,20 @@ }, { "name" : "format", + "type" : "function", "desc" : "Formats a date given the supplied format string", + "sig" : "(format)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Date", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "format", @@ -83,15 +100,20 @@ }, { "name" : "clearTime", + "type" : "function", "desc" : "Clears any time information from this date", + "sig" : "(clone)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Date", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "clone", @@ -110,15 +132,20 @@ }, { "name" : "getGMTColonOffset", + "type" : "function", "desc" : "Get the offset from GMT of the current date (equivalent to the format specifier 'P').", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Date", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -130,15 +157,20 @@ }, { "name" : "getLastDateOfMonth", + "type" : "function", "desc" : "Get the last date of this date's month", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Date", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -150,15 +182,20 @@ }, { "name" : "getTimezone", + "type" : "function", "desc" : "Get the timezone abbreviation of the current date (equivalent to the format specifier 'T').", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Date", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -170,15 +207,20 @@ }, { "name" : "getElapsed", + "type" : "function", "desc" : "Returns the number of milliseconds between this date and date", + "sig" : "(date)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Date", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "date", @@ -197,15 +239,20 @@ }, { "name" : "add", + "type" : "function", "desc" : "Provides a convenient method of performing basic date arithmetic. This method\ndoes not modify the Date instance being called - it creates and returns\na new Date instance containing the resulting date value.\n\nExamples:\n
\n//Basic usage:\nvar dt = new Date('10/29/2006').add(Date.DAY, 5);\ndocument.write(dt); //returns 'Fri Oct 06 2006 00:00:00'\n\n//Negative values will subtract correctly:\nvar dt2 = new Date('10/1/2006').add(Date.DAY, -5);\ndocument.write(dt2); //returns 'Tue Sep 26 2006 00:00:00'\n\n//You can even chain several calls together in one line!\nvar dt3 = new Date('10/1/2006').add(Date.DAY, 5).add(Date.HOUR, 8).add(Date.MINUTE, -30);\ndocument.write(dt3); //returns 'Fri Oct 06 2006 07:30:00'\n 
", + "sig" : "(interval, value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Date", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "interval", @@ -230,15 +277,20 @@ }, { "name" : "getSuffix", + "type" : "function", "desc" : "Get the English ordinal suffix of the current day (equivalent to the format specifier 'S').", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Date", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -250,15 +302,20 @@ }, { "name" : "getFirstDayOfMonth", + "type" : "function", "desc" : "Get the first day of the current month, adjusted for leap year. The returned value\nis the numeric day index within the week (0-6) which can be used in conjunction with\nthe {@link #monthNames} array to retrieve the textual day name.\nExample:\n
\nvar dt = new Date('1/10/2007');\ndocument.write(Date.dayNames[dt.getFirstDayOfMonth()]); //output: 'Monday'\n
", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Date", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -270,15 +327,20 @@ }, { "name" : "getGMTOffset", + "type" : "function", "desc" : "Get the offset from GMT of the current date (equivalent to the format specifier 'O').", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Date", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -290,15 +352,20 @@ }, { "name" : "getDaysInMonth", + "type" : "function", "desc" : "Get the number of days in the current month, adjusted for leap year.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Date", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -310,15 +377,20 @@ }, { "name" : "clone", + "type" : "function", "desc" : "Creates and returns a new Date instance with the exact same date value as the called instance.\nDates are copied and passed by reference, so if a copied date variable is modified later, the original\nvariable will also be changed. When the intention is to create a new variable that will not\nmodify the original instance, you should create a clone.\n\nExample of correctly cloning a date:\n
\n//wrong way:\nvar orig = new Date('10/1/2006');\nvar copy = orig;\ncopy.setDate(5);\ndocument.write(orig);  //returns 'Thu Oct 05 2006'!\n\n//correct way:\nvar orig = new Date('10/1/2006');\nvar copy = orig.clone();\ncopy.setDate(5);\ndocument.write(orig);  //returns 'Thu Oct 01 2006'\n
", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Date", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -330,15 +402,20 @@ }, { "name" : "getWeekOfYear", + "type" : "function", "desc" : "Get the string representation of the numeric week number of the year\n(equivalent to the format specifier 'W').", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Date", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -350,15 +427,20 @@ }, { "name" : "isLeapYear", + "type" : "function", "desc" : "Whether or not the current date is in a leap year.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Date", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -370,15 +452,20 @@ }, { "name" : "getLastDayOfMonth", + "type" : "function", "desc" : "Get the last day of the current month, adjusted for leap year. The returned value\nis the numeric day index within the week (0-6) which can be used in conjunction with\nthe {@link #monthNames} array to retrieve the textual day name.\nExample:\n
\nvar dt = new Date('1/10/2007');\ndocument.write(Date.dayNames[dt.getLastDayOfMonth()]); //output: 'Wednesday'\n
", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Date", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -390,15 +477,20 @@ }, { "name" : "parseDate", + "type" : "function", "desc" : "Parses the passed string using the specified format. Note that this function expects dates in normal calendar\nformat, meaning that months are 1-based (1 = January) and not zero-based like in JavaScript dates. Any part of\nthe date format that is not specified will default to the current date value for that part. Time parts can also\nbe specified, but default to 0. Keep in mind that the input date string must precisely match the specified format\nstring or the parse operation will fail.\nExample Usage:\n
\n//dt = Fri May 25 2007 (current date)\nvar dt = new Date();\n\n//dt = Thu May 25 2006 (today's month/day in 2006)\ndt = Date.parseDate(\"2006\", \"Y\");\n\n//dt = Sun Jan 15 2006 (all date parts specified)\ndt = Date.parseDate(\"2006-1-15\", \"Y-m-d\");\n\n//dt = Sun Jan 15 2006 15:20:01 GMT-0600 (CST)\ndt = Date.parseDate(\"2006-1-15 3:20:01 PM\", \"Y-m-d h:i:s A\" );\n
", + "sig" : "(input, format)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Date", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "input", diff --git a/docs/symbols/Function.json b/docs/symbols/Function.json index d8b03d7f9e..70f6b051bf 100644 --- a/docs/symbols/Function.json +++ b/docs/symbols/Function.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "createDelegate", + "type" : "function", "desc" : "Creates a delegate (callback) that sets the scope to obj.\nCall directly on any function. Example: this.myFunction.createDelegate(this)\nWill create a function that is automatically scoped to this.", + "sig" : "(obj, args, appendArgs)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Function", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "obj", @@ -55,15 +62,20 @@ }, { "name" : "defer", + "type" : "function", "desc" : "Calls this function after the number of millseconds specified.", + "sig" : "(millis, obj, args, appendArgs)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Function", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "millis", @@ -100,15 +112,20 @@ }, { "name" : "createSequence", + "type" : "function", "desc" : "Create a combined function call sequence of the original function + the passed function.\nThe resulting function returns the results of the original function.\nThe passed fcn is called with the parameters of the original function", + "sig" : "(fcn, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Function", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fcn", @@ -133,15 +150,20 @@ }, { "name" : "createInterceptor", + "type" : "function", "desc" : "Creates an interceptor function. The passed fcn is called before the original one. If it returns false, the original one is not called.\nThe resulting function returns the results of the original function.\nThe passed fcn is called with the parameters of the original function.", + "sig" : "(fcn, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Function", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fcn", @@ -166,15 +188,20 @@ }, { "name" : "createCallback", + "type" : "function", "desc" : "Creates a callback that passes arguments[0], arguments[1], arguments[2], ...\nCall directly on any function. Example: myFunction.createCallback(myarg, myarg2)\nWill create a function that is bound to those 2 args.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Function", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { diff --git a/docs/symbols/Number.json b/docs/symbols/Number.json index 9c0c9e4fb2..1e7e6109c6 100644 --- a/docs/symbols/Number.json +++ b/docs/symbols/Number.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "constrain", + "type" : "function", "desc" : "Checks whether or not the current number is within a desired range. If the number is already within the\nrange it is returned, otherwise the min or max value is returned depending on which side of the range is\nexceeded. Note that this method returns the constrained value but does not change the current number.", + "sig" : "(min, max)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Number", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "min", diff --git a/docs/symbols/Roo.Ajax.json b/docs/symbols/Roo.Ajax.json index 7555e1160f..020ce4ff25 100644 --- a/docs/symbols/Roo.Ajax.json +++ b/docs/symbols/Roo.Ajax.json @@ -15,76 +15,75 @@ "see" : "", "params" : [], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "method", "type" : "String", "desc" : "(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)", - "memberOf" : "Roo.Ajax", - "optvals" : [] + "memberOf" : "" }, { "name" : "timeout", "type" : "Number", "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)", - "memberOf" : "Roo.Ajax", - "optvals" : [] + "memberOf" : "" }, { "name" : "autoAbort", "type" : "Boolean", "desc" : "(Optional) Whether a new request should abort any pending requests. (defaults to false)", - "memberOf" : "Roo.Ajax", - "optvals" : [] + "memberOf" : "" }, { "name" : "url", "type" : "String", "desc" : "The default URL to be used for requests to the server. (defaults to undefined)", - "memberOf" : "Roo.Ajax", - "optvals" : [] + "memberOf" : "" }, { "name" : "extraParams", "type" : "Object", "desc" : "An object containing properties which are used as extra parameters to each request made by this object. (defaults to undefined)", - "memberOf" : "Roo.Ajax", - "optvals" : [] + "memberOf" : "" }, { "name" : "disableCaching", "type" : "Boolean", "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)", - "memberOf" : "Roo.Ajax", - "optvals" : [] + "memberOf" : "" }, { "name" : "defaultHeaders", "type" : "Object", "desc" : "An object containing request headers which are added to each request made by this object. (defaults to undefined)", - "memberOf" : "Roo.Ajax", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "isLoading", + "type" : "function", "desc" : "Determine whether this object has a request outstanding.", + "sig" : "(transactionId)", + "static" : false, + "memberOf" : "Roo.data.Connection", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Connection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "transactionId", @@ -103,15 +102,20 @@ }, { "name" : "request", + "type" : "function", "desc" : "Sends an HTTP request to a remote server.", + "sig" : "(options)", + "static" : false, + "memberOf" : "Roo.data.Connection", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Connection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "options", @@ -130,15 +134,20 @@ }, { "name" : "abort", + "type" : "function", "desc" : "Aborts any outstanding request.", + "sig" : "(transactionId)", + "static" : false, + "memberOf" : "Roo.data.Connection", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Connection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "transactionId", @@ -151,29 +160,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -204,15 +223,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -237,15 +261,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -258,15 +287,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -279,15 +313,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -312,15 +351,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -345,15 +389,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -372,15 +421,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -405,15 +459,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -446,7 +505,9 @@ "events" : [ { "name" : "requestcomplete", + "type" : "function", "desc" : "Fires if the request was successfully completed.", + "sig" : "function (conn, response, options)\n{\n\n}", "memberOf" : "Roo.data.Connection", "example" : "", "deprecated" : "", @@ -476,7 +537,9 @@ }, { "name" : "beforerequest", + "type" : "function", "desc" : "Fires before a network request is made to retrieve a data object.", + "sig" : "function (conn, options)\n{\n\n}", "memberOf" : "Roo.data.Connection", "example" : "", "deprecated" : "", @@ -500,7 +563,9 @@ }, { "name" : "requestexception", + "type" : "function", "desc" : "Fires if an error HTTP status was returned from the server.\nSee {@link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html} for details of HTTP status codes.", + "sig" : "function (conn, response, options)\n{\n\n}", "memberOf" : "Roo.data.Connection", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.BasicDialog.json b/docs/symbols/Roo.BasicDialog.json index 044e632666..f7e3f4ab97 100644 --- a/docs/symbols/Roo.BasicDialog.json +++ b/docs/symbols/Roo.BasicDialog.json @@ -27,237 +27,220 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "y", "type" : "Number", "desc" : "The default top page coordinate of the dialog (defaults to center screen)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "modal", "type" : "Boolean", "desc" : "True to show the dialog modally, preventing user interaction with the rest of the page (defaults to false)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "animateTarget", "type" : "String/Element", "desc" : "Id or element from which the dialog should animate while opening\n(defaults to null with no animation)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "shadow", "type" : "Boolean/String", "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right\nshadow (defaults to false)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "autoScroll", "type" : "Boolean", "desc" : "True to allow the dialog body contents to overflow and display scrollbars (defaults to false)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "collapsible", "type" : "Boolean", "desc" : "False to remove the built-in top-right corner collapse button (defaults to true)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "autoTabs", "type" : "Boolean", "desc" : "If true, all elements with class 'x-dlg-tab' will get automatically converted to tabs (defaults to false)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "shadowOffset", "type" : "Number", "desc" : "The number of pixels to offset the shadow if displayed (defaults to 5)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "buttons", "type" : "Array", "desc" : "Array of buttons", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "minButtonWidth", "type" : "Number", "desc" : "Minimum width of all dialog buttons (defaults to 75)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "title", "type" : "String", "desc" : "Default text to display in the title bar (defaults to null)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "minWidth", "type" : "Number", "desc" : "The minimum allowable width for a resizable dialog (defaults to 200)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "buttonAlign", "type" : "String", "desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"right\")", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "autoCreate", "type" : "Boolean/DomHelper", "desc" : "True to auto create from scratch, or using a DomHelper Object (defaults to false)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "minHeight", "type" : "Number", "desc" : "The minimum allowable height for a resizable dialog (defaults to 80)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "proxyDrag", "type" : "Boolean", "desc" : "True to drag a lightweight proxy element rather than the dialog itself, used when\ndraggable = true (defaults to false)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "shim", "type" : "Boolean", "desc" : "True to create an iframe shim that prevents selects from showing through (defaults to false)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "width", "type" : "Number", "desc" : "Width of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "constraintoviewport", "type" : "Boolean", "desc" : "True to keep the dialog constrained within the visible viewport boundaries (defaults to true)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "syncHeightBeforeShow", "type" : "Boolean", "desc" : "True to cause the dimensions to be recalculated before the dialog is shown (defaults to false)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "tabTag", "type" : "String", "desc" : "The tag name of tab elements, used when autoTabs = true (defaults to 'div')", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "resizable", "type" : "Boolean", "desc" : "False to disable manual dialog resizing (defaults to true)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "closable", "type" : "Boolean", "desc" : "False to remove the built-in top-right corner close button (defaults to true)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "fixedcenter", "type" : "Boolean", "desc" : "True to ensure that anytime the dialog is shown or resized it gets centered (defaults to false)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "height", "type" : "Number", "desc" : "Height of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "resizeHandles", "type" : "String", "desc" : "Which resize handles to display - see the {@link Roo.Resizable} handles config\nproperty for valid values (defaults to 'all')", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "x", "type" : "Number", "desc" : "The default left page coordinate of the dialog (defaults to center screen)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" }, { "name" : "draggable", "type" : "Boolean", "desc" : "False to disable dragging of the dialog within the viewport (defaults to true)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "expand", + "type" : "function", "desc" : "Expands a collapsed dialog back to its normal state. Equivalent to the user\nclicking the expand dialog button.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "alignTo", + "type" : "function", "desc" : "Aligns the dialog to the specified element", + "sig" : "(element, position, offsets)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "element", @@ -288,15 +271,20 @@ }, { "name" : "setTitle", + "type" : "function", "desc" : "Sets the dialog title text", + "sig" : "(text)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "text", @@ -315,15 +303,20 @@ }, { "name" : "isVisible", + "type" : "function", "desc" : "Returns true if the dialog is visible", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -335,15 +328,20 @@ }, { "name" : "resizeTo", + "type" : "function", "desc" : "Resizes the dialog.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -368,15 +366,20 @@ }, { "name" : "center", + "type" : "function", "desc" : "Centers this dialog in the viewport", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -388,29 +391,39 @@ }, { "name" : "collapse", + "type" : "function", "desc" : "Collapses the dialog to its minimized state (only the title bar is visible).\nEquivalent to the user clicking the collapse dialog button.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "initTabs", + "type" : "function", "desc" : "Reinitializes the tabs component, clearing out old tabs and finding new ones.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -422,15 +435,20 @@ }, { "name" : "toFront", + "type" : "function", "desc" : "Brings this dialog to the front of any other visible dialogs", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -442,15 +460,20 @@ }, { "name" : "moveTo", + "type" : "function", "desc" : "Moves the dialog's top-left corner to the specified point", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -475,15 +498,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hides the dialog.", + "sig" : "(callback)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "callback", @@ -502,15 +530,20 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Destroys this dialog and all its supporting elements (including any tabs, shim,\nshadow, proxy, mask, etc.) Also removes all event listeners.", + "sig" : "(removeEl)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "removeEl", @@ -523,15 +556,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Shows the dialog.", + "sig" : "(animateTarget)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "animateTarget", @@ -550,15 +588,20 @@ }, { "name" : "anchorTo", + "type" : "function", "desc" : "Anchors an element to another element and realigns it when the window is resized.", + "sig" : "(element, position, offsets, monitorScroll)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "element", @@ -595,15 +638,20 @@ }, { "name" : "addButton", + "type" : "function", "desc" : "Adds a button to the footer section of the dialog.", + "sig" : "(config, handler, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -634,15 +682,20 @@ }, { "name" : "addKeyListener", + "type" : "function", "desc" : "Adds a key listener for when this dialog is displayed. This allows you to hook in a function that will be\nexecuted in response to a particular key being pressed while the dialog is active.", + "sig" : "(key, fn, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "key", @@ -673,29 +726,39 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Focuses the dialog. If a defaultButton is set, it will receive focus, otherwise the\ndialog itself will receive focus.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getTabs", + "type" : "function", "desc" : "Returns the TabPanel component (creates it if it doesn't exist).\nNote: If you wish to simply check for the existence of tabs without creating them,\ncheck for a null 'tabs' property.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -707,15 +770,20 @@ }, { "name" : "setDefaultButton", + "type" : "function", "desc" : "Sets the default button to be focused when the dialog is displayed.", + "sig" : "(btn)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "btn", @@ -734,15 +802,20 @@ }, { "name" : "toBack", + "type" : "function", "desc" : "Sends this dialog to the back (under) of any other visible dialogs", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -754,15 +827,20 @@ }, { "name" : "setContentSize", + "type" : "function", "desc" : "Resizes the dialog to fit the specified content size.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -787,15 +865,20 @@ }, { "name" : "restoreState", + "type" : "function", "desc" : "Restores the previous state of the dialog if Roo.state is configured.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -807,15 +890,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the element for this dialog", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -827,29 +915,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -880,15 +978,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -913,15 +1016,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -934,15 +1042,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -955,15 +1068,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -988,15 +1106,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1021,15 +1144,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1048,15 +1176,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1081,15 +1214,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1122,8 +1260,10 @@ "events" : [ { "name" : "move", + "type" : "function", "desc" : "Fires when this dialog is moved by the user.", - "memberOf" : "Roo.BasicDialog", + "sig" : "function (_self, x, y)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1152,8 +1292,10 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires when this dialog is resized by the user.", - "memberOf" : "Roo.BasicDialog", + "sig" : "function (_self, width, height)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1182,8 +1324,10 @@ }, { "name" : "beforehide", + "type" : "function", "desc" : "Fires before this dialog is hidden.", - "memberOf" : "Roo.BasicDialog", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1200,8 +1344,10 @@ }, { "name" : "beforeshow", + "type" : "function", "desc" : "Fires before this dialog is shown.", - "memberOf" : "Roo.BasicDialog", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1218,8 +1364,10 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires when this dialog is hidden.", - "memberOf" : "Roo.BasicDialog", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1236,8 +1384,10 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires when this dialog is shown.", - "memberOf" : "Roo.BasicDialog", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1254,8 +1404,10 @@ }, { "name" : "keydown", + "type" : "function", "desc" : "Fires when a key is pressed", - "memberOf" : "Roo.BasicDialog", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.BasicLayoutRegion.json b/docs/symbols/Roo.BasicLayoutRegion.json index 40fd7fba36..c61584c916 100644 --- a/docs/symbols/Roo.BasicLayoutRegion.json +++ b/docs/symbols/Roo.BasicLayoutRegion.json @@ -14,27 +14,33 @@ "see" : "", "params" : [], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" } ], "methods" : [ { "name" : "isVisible", + "type" : "function", "desc" : "Returns true if this region is currently visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -46,15 +52,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the container element for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -66,15 +77,20 @@ }, { "name" : "hasPanel", + "type" : "function", "desc" : "Returns true if the panel is in this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -93,15 +109,20 @@ }, { "name" : "getActivePanel", + "type" : "function", "desc" : "Get the active panel for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -113,15 +134,20 @@ }, { "name" : "resizeTo", + "type" : "function", "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.", + "sig" : "(newSize)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "newSize", @@ -134,15 +160,20 @@ }, { "name" : "showPanel", + "type" : "function", "desc" : "Show the specified panel.", + "sig" : "(panelId)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panelId", @@ -161,15 +192,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Returns this regions position (north/south/east/west/center).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -181,15 +217,20 @@ }, { "name" : "add", + "type" : "function", "desc" : "Add the passed ContentPanel(s)", + "sig" : "(panel)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -208,15 +249,20 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.", + "sig" : "(panel, preservePanel)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -241,15 +287,20 @@ }, { "name" : "getPanel", + "type" : "function", "desc" : "Returns the panel specified or null if it's not in this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -268,29 +319,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -321,15 +382,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -354,15 +420,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -375,15 +446,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -396,15 +472,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -429,15 +510,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -462,15 +548,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -489,15 +580,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -522,15 +618,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -563,8 +664,10 @@ "events" : [ { "name" : "paneladded", + "type" : "function", "desc" : "Fires when a panel is added.", - "memberOf" : "Roo.BasicLayoutRegion", + "sig" : "function (_self, panel)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -587,8 +690,10 @@ }, { "name" : "invalidated", + "type" : "function", "desc" : "Fires when the layout for this region is changed.", - "memberOf" : "Roo.BasicLayoutRegion", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -605,8 +710,10 @@ }, { "name" : "expanded", + "type" : "function", "desc" : "Fires when this region is expanded.", - "memberOf" : "Roo.BasicLayoutRegion", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -623,8 +730,10 @@ }, { "name" : "beforeremove", + "type" : "function", "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.", - "memberOf" : "Roo.BasicLayoutRegion", + "sig" : "function (_self, panel, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -653,8 +762,10 @@ }, { "name" : "collapsed", + "type" : "function", "desc" : "Fires when this region is collapsed.", - "memberOf" : "Roo.BasicLayoutRegion", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -671,8 +782,10 @@ }, { "name" : "panelremoved", + "type" : "function", "desc" : "Fires when a panel is removed.", - "memberOf" : "Roo.BasicLayoutRegion", + "sig" : "function (_self, panel)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -695,8 +808,10 @@ }, { "name" : "beforecollapse", + "type" : "function", "desc" : "Fires when this region before collapse.", - "memberOf" : "Roo.BasicLayoutRegion", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -713,8 +828,10 @@ }, { "name" : "slidehide", + "type" : "function", "desc" : "Fires when this region slides out of view.", - "memberOf" : "Roo.BasicLayoutRegion", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -731,8 +848,10 @@ }, { "name" : "visibilitychange", + "type" : "function", "desc" : "Fires when this region is shown or hidden", - "memberOf" : "Roo.BasicLayoutRegion", + "sig" : "function (_self, visibility)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -755,8 +874,10 @@ }, { "name" : "slideshow", + "type" : "function", "desc" : "Fires when this region is slid into view.", - "memberOf" : "Roo.BasicLayoutRegion", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -773,8 +894,10 @@ }, { "name" : "panelactivated", + "type" : "function", "desc" : "Fires when a panel is activated.", - "memberOf" : "Roo.BasicLayoutRegion", + "sig" : "function (_self, panel)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -797,8 +920,10 @@ }, { "name" : "resized", + "type" : "function", "desc" : "Fires when the user resizes this region.", - "memberOf" : "Roo.BasicLayoutRegion", + "sig" : "function (_self, newSize)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.BorderLayout.json b/docs/symbols/Roo.BorderLayout.json index 08ff98b429..78e09cde93 100644 --- a/docs/symbols/Roo.BorderLayout.json +++ b/docs/symbols/Roo.BorderLayout.json @@ -28,27 +28,63 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ + { + "name" : "center", + "type" : "Roo.LayoutRegion", + "desc" : "", + "memberOf" : "" + }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "east", + "type" : "Roo.LayoutRegion", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "west", + "type" : "Roo.LayoutRegion", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "north", + "type" : "Roo.LayoutRegion", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "south", + "type" : "Roo.LayoutRegion", + "desc" : "", + "memberOf" : "" } ], "methods" : [ { "name" : "create", + "type" : "function", "desc" : "Shortcut for creating a new BorderLayout object and adding one or more ContentPanels to it in a single step, handling\nthe beginUpdate and endUpdate calls internally. The key to this method is the panels property that can be\nprovided with each region config, which allows you to add ContentPanel configs in addition to the region configs\nduring creation. The following code is equivalent to the constructor-based example at the beginning of this class:\n
\n// shorthand\nvar CP = Roo.ContentPanel;\n\nvar layout = Roo.BorderLayout.create({\n    north: {\n        initialSize: 25,\n        titlebar: false,\n        panels: [new CP(\"north\", \"North\")]\n    },\n    west: {\n        split:true,\n        initialSize: 200,\n        minSize: 175,\n        maxSize: 400,\n        titlebar: true,\n        collapsible: true,\n        panels: [new CP(\"west\", {title: \"West\"})]\n    },\n    east: {\n        split:true,\n        initialSize: 202,\n        minSize: 175,\n        maxSize: 400,\n        titlebar: true,\n        collapsible: true,\n        panels: [new CP(\"autoTabs\", {title: \"Auto Tabs\", closable: true})]\n    },\n    south: {\n        split:true,\n        initialSize: 100,\n        minSize: 100,\n        maxSize: 200,\n        titlebar: true,\n        collapsible: true,\n        panels: [new CP(\"south\", {title: \"South\", closable: true})]\n    },\n    center: {\n        titlebar: true,\n        autoScroll:true,\n        resizeTabs: true,\n        minTabWidth: 50,\n        preferredTabWidth: 150,\n        panels: [\n            new CP(\"center1\", {title: \"Close Me\", closable: true}),\n            new CP(\"center2\", {title: \"Center Panel\", closable: false})\n        ]\n    }\n}, document.body);\n\nlayout.getRegion(\"center\").showPanel(\"center1\");\n
", + "sig" : "(config, targetEl)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BorderLayout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -67,15 +103,20 @@ }, { "name" : "restoreState", + "type" : "function", "desc" : "Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.", + "sig" : "(provider)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BorderLayout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "provider", @@ -88,15 +129,20 @@ }, { "name" : "addRegion", + "type" : "function", "desc" : "Creates and adds a new region if it doesn't already exist.", + "sig" : "(target, config)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BorderLayout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -121,15 +167,20 @@ }, { "name" : "showPanel", + "type" : "function", "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.", + "sig" : "(panelId)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BorderLayout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panelId", @@ -148,15 +199,20 @@ }, { "name" : "batchAdd", + "type" : "function", "desc" : "Adds a batch of multiple ContentPanels dynamically by passing a special regions config object. This config\nobject should contain properties for each region to add ContentPanels to, and each property's value should be\na valid ContentPanel config object. Example:\n
\n// Create the main layout\nvar layout = new Roo.BorderLayout('main-ct', {\n    west: {\n        split:true,\n        minSize: 175,\n        titlebar: true\n    },\n    center: {\n        title:'Components'\n    }\n}, 'main-ct');\n\n// Create and add multiple ContentPanels at once via configs\nlayout.batchAdd({\n   west: {\n       id: 'source-files',\n       autoCreate:true,\n       title:'Ext Source Files',\n       autoScroll:true,\n       fitToFrame:true\n   },\n   center : {\n       el: cview,\n       autoScroll:true,\n       fitToFrame:true,\n       toolbar: tb,\n       resizeEl:'cbody'\n   }\n});\n
", + "sig" : "(regions)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BorderLayout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "regions", @@ -169,15 +225,20 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Remove a ContentPanel (or subclass) to this layout.", + "sig" : "(target, panel)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BorderLayout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -202,15 +263,20 @@ }, { "name" : "findPanel", + "type" : "function", "desc" : "Searches all regions for a panel with the specified id", + "sig" : "(panelId)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BorderLayout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panelId", @@ -229,29 +295,39 @@ }, { "name" : "layout", + "type" : "function", "desc" : "Performs a layout update.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BorderLayout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "addxtype", + "type" : "function", "desc" : "Adds a xtype elements to the layout.\n
\n\nlayout.addxtype({\n       xtype : 'ContentPanel',\n       region: 'west',\n       items: [ .... ]\n   }\n);\n\nlayout.addxtype({\n        xtype : 'NestedLayoutPanel',\n        region: 'west',\n        layout: {\n           center: { },\n           west: { }   \n        },\n        items : [ ... list of content panels or nested layout panels.. ]\n   }\n);\n
", + "sig" : "(cfg)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BorderLayout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cfg", @@ -264,15 +340,20 @@ }, { "name" : "add", + "type" : "function", "desc" : "Adds a ContentPanel (or subclass) to this layout.", + "sig" : "(target, panel)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BorderLayout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -297,15 +378,20 @@ }, { "name" : "getRegion", + "type" : "function", "desc" : "Returns the specified region.", + "sig" : "(target)", + "static" : false, + "memberOf" : "Roo.LayoutManager", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -324,29 +410,39 @@ }, { "name" : "beginUpdate", + "type" : "function", "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutManager", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isUpdating", + "type" : "function", "desc" : "Returns true if this layout is currently being updated", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutManager", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -358,15 +454,20 @@ }, { "name" : "getViewSize", + "type" : "function", "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutManager", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -378,15 +479,20 @@ }, { "name" : "endUpdate", + "type" : "function", "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout", + "sig" : "(noLayout)", + "static" : false, + "memberOf" : "Roo.LayoutManager", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "noLayout", @@ -399,15 +505,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the Element this layout is bound to.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutManager", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -419,29 +530,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -472,15 +593,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -505,15 +631,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -526,15 +657,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -547,15 +683,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -580,15 +721,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -613,15 +759,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -640,15 +791,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -673,15 +829,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -714,7 +875,9 @@ "events" : [ { "name" : "layout", + "type" : "function", "desc" : "Fires when a layout is performed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", @@ -732,7 +895,9 @@ }, { "name" : "regionexpanded", + "type" : "function", "desc" : "Fires when a region is expanded.", + "sig" : "function (region)\n{\n\n}", "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", @@ -750,7 +915,9 @@ }, { "name" : "regionresized", + "type" : "function", "desc" : "Fires when the user resizes a region.", + "sig" : "function (region, newSize)\n{\n\n}", "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", @@ -774,7 +941,9 @@ }, { "name" : "regioncollapsed", + "type" : "function", "desc" : "Fires when a region is collapsed.", + "sig" : "function (region)\n{\n\n}", "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.BoxComponent.json b/docs/symbols/Roo.BoxComponent.json index 3c3e830639..8b10dbc2ab 100644 --- a/docs/symbols/Roo.BoxComponent.json +++ b/docs/symbols/Roo.BoxComponent.json @@ -22,72 +22,69 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "width", "type" : "Number", "desc" : "width (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "" }, { "name" : "height", "type" : "Number", "desc" : "height (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -100,15 +97,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -127,29 +129,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -174,15 +186,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -201,15 +218,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -240,15 +262,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -261,15 +288,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -281,15 +313,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -308,15 +345,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -335,15 +377,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -355,15 +402,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -376,43 +428,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -425,15 +492,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -445,15 +517,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -472,15 +549,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -492,15 +574,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -512,15 +599,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -539,15 +631,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -559,15 +656,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -579,29 +681,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -632,15 +744,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -665,15 +782,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -686,15 +808,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -707,15 +834,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -740,15 +872,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -773,15 +910,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -800,15 +942,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -833,15 +980,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -874,8 +1026,10 @@ "events" : [ { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", - "memberOf" : "Roo.BoxComponent", + "sig" : "function (_self, x, y)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -904,8 +1058,10 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", - "memberOf" : "Roo.BoxComponent", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -946,7 +1102,9 @@ }, { "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" : "", @@ -964,7 +1122,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -982,7 +1142,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1000,7 +1162,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1018,7 +1182,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1036,7 +1202,9 @@ }, { "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" : "", @@ -1054,7 +1222,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1072,7 +1242,9 @@ }, { "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" : "", @@ -1090,7 +1262,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1108,7 +1282,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.Button.json b/docs/symbols/Roo.Button.json index 0e333be7f1..2c2e0d5c03 100644 --- a/docs/symbols/Roo.Button.json +++ b/docs/symbols/Roo.Button.json @@ -21,216 +21,209 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "String/Object", "desc" : "The tooltip for the button - can be a string or QuickTips config object", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "text", "type" : "String", "desc" : "The button text", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "renderTo", "type" : "String/HTMLElement/Element", "desc" : "The element to append the button to", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "hidden", "type" : "Boolean", "desc" : "True to start hidden (defaults to false)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "toggleGroup", "type" : "String", "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "handleMouseEvents", "type" : "Boolean", "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "menu", - "type" : "Mixed", + "type" : "Roo.menu.Menu", "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "enableToggle", "type" : "Boolean", "desc" : "True to enable pressed/not pressed toggling (defaults to false)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "handler", "type" : "Function", "desc" : "A function called when the button is clicked (can be used instead of click event)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "scope", "type" : "Object", "desc" : "The scope of the handler", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "minWidth", "type" : "Number", "desc" : "The minimum width for this button (used to give a set of buttons a common width)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to start disabled (defaults to false)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "pressed", "type" : "Boolean", "desc" : "True to start pressed (only if enableToggle = true)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "template", "type" : "Roo.Template", "desc" : "(Optional)\nAn {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the button's main element.", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The DOM tabIndex for this button (defaults to undefined)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "iconCls", "type" : "String", "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "menuAlign", "type" : "String", "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "icon", "type" : "String", "desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "tooltipType", "type" : "String", "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "clickEvent", "type" : "String", "desc" : "The type of event to map to the button's event handler (defaults to 'click')", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "repeat", "type" : "Boolean/Object", "desc" : "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "type", "type" : "String", "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "show", + "type" : "function", "desc" : "Show this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "focus", + "type" : "function", "desc" : "Focus the button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setHandler", + "type" : "function", "desc" : "Assigns this button's click handler", + "sig" : "(handler, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "handler", @@ -249,43 +242,58 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "enable", + "type" : "function", "desc" : "Enable this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the button's underlying element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -297,15 +305,20 @@ }, { "name" : "setDisabled", + "type" : "function", "desc" : "Convenience function for boolean enable/disable", + "sig" : "(enabled)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "enabled", @@ -318,15 +331,20 @@ }, { "name" : "setVisible", + "type" : "function", "desc" : "Convenience function for boolean show/hide", + "sig" : "(visible)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -339,29 +357,39 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Destroys this Button and removes any listeners.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getText", + "type" : "function", "desc" : "Gets the text for this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -373,15 +401,20 @@ }, { "name" : "setText", + "type" : "function", "desc" : "Sets this button's text", + "sig" : "(text)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "text", @@ -394,15 +427,20 @@ }, { "name" : "toggle", + "type" : "function", "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.", + "sig" : "(state)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "state", @@ -415,43 +453,58 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -482,15 +535,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -515,15 +573,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -536,15 +599,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -557,15 +625,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -590,15 +663,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -623,15 +701,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -650,15 +733,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -683,15 +771,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -724,8 +817,10 @@ "events" : [ { "name" : "render", + "type" : "function", "desc" : "Fires when the button is rendered", - "memberOf" : "Roo.Button", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -742,8 +837,10 @@ }, { "name" : "click", + "type" : "function", "desc" : "Fires when this button is clicked", - "memberOf" : "Roo.Button", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -766,8 +863,10 @@ }, { "name" : "mouseover", + "type" : "function", "desc" : "Fires when the mouse hovers over the button", - "memberOf" : "Roo.Button", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -790,8 +889,10 @@ }, { "name" : "toggle", + "type" : "function", "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)", - "memberOf" : "Roo.Button", + "sig" : "function (_self, pressed)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -814,8 +915,10 @@ }, { "name" : "mouseout", + "type" : "function", "desc" : "Fires when the mouse exits the button", - "memberOf" : "Roo.Button", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.CalendarPanel.json b/docs/symbols/Roo.CalendarPanel.json index e1ae7f1219..c645e71218 100644 --- a/docs/symbols/Roo.CalendarPanel.json +++ b/docs/symbols/Roo.CalendarPanel.json @@ -22,58 +22,57 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -85,15 +84,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -106,43 +110,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -155,15 +174,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -175,15 +199,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -202,15 +231,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -222,15 +256,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -242,15 +281,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -269,15 +313,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -289,15 +338,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -309,29 +363,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -362,15 +426,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -395,15 +464,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -416,15 +490,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -437,15 +516,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -470,15 +554,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -503,15 +592,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -530,15 +624,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -563,15 +662,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -604,8 +708,10 @@ "events" : [ { "name" : "monthchange", + "type" : "function", "desc" : "Fires when the displayed month changes", - "memberOf" : "Roo.CalendarPanel", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -628,8 +734,10 @@ }, { "name" : "evententer", + "type" : "function", "desc" : "Fires when mouse over an event", - "memberOf" : "Roo.CalendarPanel", + "sig" : "function (_self, Event)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -652,8 +760,10 @@ }, { "name" : "eventleave", + "type" : "function", "desc" : "Fires when the mouse leaves an", - "memberOf" : "Roo.CalendarPanel", + "sig" : "function (_self, )\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -676,8 +786,10 @@ }, { "name" : "eventclick", + "type" : "function", "desc" : "Fires when the mouse click an", - "memberOf" : "Roo.CalendarPanel", + "sig" : "function (_self, )\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -700,8 +812,10 @@ }, { "name" : "rendered", + "type" : "function", "desc" : "Fires when the grid is rendered", - "memberOf" : "Roo.CalendarPanel", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -718,8 +832,10 @@ }, { "name" : "select", + "type" : "function", "desc" : "Fires when a date is selected", - "memberOf" : "Roo.CalendarPanel", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -742,7 +858,9 @@ }, { "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" : "", @@ -760,7 +878,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -778,7 +898,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -796,7 +918,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -814,7 +938,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -832,7 +958,9 @@ }, { "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" : "", @@ -850,7 +978,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -868,7 +998,9 @@ }, { "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" : "", @@ -886,7 +1018,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -904,7 +1038,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.ColorPalette.json b/docs/symbols/Roo.ColorPalette.json index e0a352deb4..f9d51bc40f 100644 --- a/docs/symbols/Roo.ColorPalette.json +++ b/docs/symbols/Roo.ColorPalette.json @@ -22,79 +22,75 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "allowReselect", "type" : "Boolean", "desc" : "If set to true then reselecting a color that is already selected fires the selection event", - "memberOf" : "Roo.ColorPalette", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "value", "type" : "String", "desc" : "The initial color to highlight (should be a valid 6-digit color hex code without the # symbol). Note that\nthe hex codes are case-sensitive.", - "memberOf" : "Roo.ColorPalette", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "itemCls", "type" : "String", "desc" : "The CSS class to apply to the containing element (defaults to \"x-color-palette\")", - "memberOf" : "Roo.ColorPalette", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "select", + "type" : "function", "desc" : "Selects the specified color in the palette (fires the select event)", + "sig" : "(color)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ColorPalette", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "color", @@ -107,15 +103,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -127,15 +128,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -148,43 +154,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -197,15 +218,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -217,15 +243,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -244,15 +275,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -264,15 +300,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -284,15 +325,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -311,15 +357,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -331,15 +382,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -351,29 +407,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -404,15 +470,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -437,15 +508,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -458,15 +534,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -479,15 +560,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -512,15 +598,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -545,15 +636,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -572,15 +668,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -605,15 +706,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -646,8 +752,10 @@ "events" : [ { "name" : "select", + "type" : "function", "desc" : "Fires when a color is selected", - "memberOf" : "Roo.ColorPalette", + "sig" : "function (_self, color)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -670,7 +778,9 @@ }, { "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" : "", @@ -688,7 +798,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -706,7 +818,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -724,7 +838,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -742,7 +858,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -760,7 +878,9 @@ }, { "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" : "", @@ -778,7 +898,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -796,7 +918,9 @@ }, { "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" : "", @@ -814,7 +938,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -832,7 +958,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.Component.json b/docs/symbols/Roo.Component.json index c6c8494b84..26f75370c1 100644 --- a/docs/symbols/Roo.Component.json +++ b/docs/symbols/Roo.Component.json @@ -21,58 +21,57 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [] + "memberOf" : "" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "getId", + "type" : "function", "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -84,15 +83,20 @@ }, { "name" : "render", + "type" : "function", "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -105,43 +109,58 @@ }, { "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" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "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" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "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" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -154,15 +173,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -174,15 +198,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -201,15 +230,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -221,15 +255,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -241,15 +280,20 @@ }, { "name" : "setVisible", + "type" : "function", "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -268,15 +312,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -288,15 +337,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -308,29 +362,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -361,15 +425,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -394,15 +463,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -415,15 +489,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -436,15 +515,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -469,15 +553,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -502,15 +591,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -529,15 +623,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -562,15 +661,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -603,8 +707,10 @@ "events" : [ { "name" : "beforerender", + "type" : "function", "desc" : "Fires before the component is rendered. Return false to stop the render.", - "memberOf" : "Roo.Component", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -621,8 +727,10 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", - "memberOf" : "Roo.Component", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -639,8 +747,10 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", - "memberOf" : "Roo.Component", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -657,8 +767,10 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", - "memberOf" : "Roo.Component", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -675,8 +787,10 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", - "memberOf" : "Roo.Component", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -693,8 +807,10 @@ }, { "name" : "beforehide", + "type" : "function", "desc" : "Fires before the component is hidden. Return false to stop the hide.", - "memberOf" : "Roo.Component", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -711,8 +827,10 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", - "memberOf" : "Roo.Component", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -729,8 +847,10 @@ }, { "name" : "beforeshow", + "type" : "function", "desc" : "Fires before the component is shown. Return false to stop the show.", - "memberOf" : "Roo.Component", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -747,8 +867,10 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", - "memberOf" : "Roo.Component", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -765,8 +887,10 @@ }, { "name" : "beforedestroy", + "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", - "memberOf" : "Roo.Component", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.ComponentMgr.json b/docs/symbols/Roo.ComponentMgr.json index d78220ec13..9ae5904a06 100644 --- a/docs/symbols/Roo.ComponentMgr.json +++ b/docs/symbols/Roo.ComponentMgr.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "onAvailable", + "type" : "function", "desc" : "Registers a function that will be called when a specified component is added to ComponentMgr", + "sig" : "(id, fn, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ComponentMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -49,15 +56,20 @@ }, { "name" : "get", + "type" : "function", "desc" : "Returns a component by id", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ComponentMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -70,15 +82,20 @@ }, { "name" : "register", + "type" : "function", "desc" : "Registers a component.", + "sig" : "(c)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ComponentMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "c", @@ -91,15 +108,20 @@ }, { "name" : "unregister", + "type" : "function", "desc" : "Unregisters a component.", + "sig" : "(c)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ComponentMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "c", diff --git a/docs/symbols/Roo.CompositeElement.json b/docs/symbols/Roo.CompositeElement.json index c54a72c363..e925b07bd8 100644 --- a/docs/symbols/Roo.CompositeElement.json +++ b/docs/symbols/Roo.CompositeElement.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "add", + "type" : "function", "desc" : "Adds elements to this composite.", + "sig" : "(els)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "els", @@ -43,15 +50,20 @@ }, { "name" : "contains", + "type" : "function", "desc" : "Returns true if this composite contains the passed element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -63,15 +75,20 @@ }, { "name" : "each", + "type" : "function", "desc" : "Calls the passed function passing (el, this, index) for each element in this composite.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -96,15 +113,20 @@ }, { "name" : "replaceElement", + "type" : "function", "desc" : "Replaces the specified element with the passed element.", + "sig" : "(el, replacement, domReplace)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -135,15 +157,20 @@ }, { "name" : "fill", + "type" : "function", "desc" : "Clears this composite and adds the elements returned by the passed selector.", + "sig" : "(els)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "els", @@ -162,29 +189,39 @@ }, { "name" : "clear", + "type" : "function", "desc" : "Removes all elements.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "filter", + "type" : "function", "desc" : "Filters this composite to only elements that match the passed selector.", + "sig" : "(selector, inverse)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -209,15 +246,20 @@ }, { "name" : "item", + "type" : "function", "desc" : "Returns the Element object at the specified index", + "sig" : "(index)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -236,15 +278,20 @@ }, { "name" : "last", + "type" : "function", "desc" : "Returns the last Element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -256,15 +303,20 @@ }, { "name" : "removeElement", + "type" : "function", "desc" : "Removes the specified element(s).", + "sig" : "(el, removeDom)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -289,15 +341,20 @@ }, { "name" : "indexOf", + "type" : "function", "desc" : "Returns true if this composite contains the passed element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -309,15 +366,20 @@ }, { "name" : "getCount", + "type" : "function", "desc" : "Returns the number of elements in this composite", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -329,15 +391,20 @@ }, { "name" : "first", + "type" : "function", "desc" : "Returns the first Element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { diff --git a/docs/symbols/Roo.CompositeElementLite.json b/docs/symbols/Roo.CompositeElementLite.json index e6f6b05bf6..0c0780b8a8 100644 --- a/docs/symbols/Roo.CompositeElementLite.json +++ b/docs/symbols/Roo.CompositeElementLite.json @@ -14,19 +14,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "each", + "type" : "function", "desc" : "Calls the passed function passing (el, this, index) for each element in this composite. The element\npassed is the flyweight (shared) Roo.Element instance, so if you require a\na reference to the dom node, use el.dom.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElementLite", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -51,15 +58,20 @@ }, { "name" : "item", + "type" : "function", "desc" : "Returns a flyweight Element of the dom element object at the specified index", + "sig" : "(index)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElementLite", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -78,15 +90,20 @@ }, { "name" : "add", + "type" : "function", "desc" : "Adds elements to this composite.", + "sig" : "(els)", + "static" : false, + "memberOf" : "Roo.CompositeElement", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "els", @@ -105,15 +122,20 @@ }, { "name" : "contains", + "type" : "function", "desc" : "Returns true if this composite contains the passed element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.CompositeElement", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -125,15 +147,20 @@ }, { "name" : "replaceElement", + "type" : "function", "desc" : "Replaces the specified element with the passed element.", + "sig" : "(el, replacement, domReplace)", + "static" : false, + "memberOf" : "Roo.CompositeElement", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -164,15 +191,20 @@ }, { "name" : "fill", + "type" : "function", "desc" : "Clears this composite and adds the elements returned by the passed selector.", + "sig" : "(els)", + "static" : false, + "memberOf" : "Roo.CompositeElement", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "els", @@ -191,29 +223,39 @@ }, { "name" : "clear", + "type" : "function", "desc" : "Removes all elements.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.CompositeElement", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "filter", + "type" : "function", "desc" : "Filters this composite to only elements that match the passed selector.", + "sig" : "(selector, inverse)", + "static" : false, + "memberOf" : "Roo.CompositeElement", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -238,15 +280,20 @@ }, { "name" : "last", + "type" : "function", "desc" : "Returns the last Element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.CompositeElement", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -258,15 +305,20 @@ }, { "name" : "removeElement", + "type" : "function", "desc" : "Removes the specified element(s).", + "sig" : "(el, removeDom)", + "static" : false, + "memberOf" : "Roo.CompositeElement", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -291,15 +343,20 @@ }, { "name" : "indexOf", + "type" : "function", "desc" : "Returns true if this composite contains the passed element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.CompositeElement", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -311,15 +368,20 @@ }, { "name" : "getCount", + "type" : "function", "desc" : "Returns the number of elements in this composite", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.CompositeElement", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -331,15 +393,20 @@ }, { "name" : "first", + "type" : "function", "desc" : "Returns the first Element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.CompositeElement", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.CompositeElement", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { diff --git a/docs/symbols/Roo.ContentPanel.json b/docs/symbols/Roo.ContentPanel.json index b27733fbcf..0b83314101 100644 --- a/docs/symbols/Roo.ContentPanel.json +++ b/docs/symbols/Roo.ContentPanel.json @@ -39,145 +39,135 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "loadOnce", "type" : "Boolean", "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "autoScroll", "type" : "Boolean", "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "fitToFrame", "type" : "Boolean", "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "background", "type" : "Boolean", "desc" : "True if the panel should not be activated when it is added (defaults to false)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "toolbar", - "type" : "Toolbar", + "type" : "Roo.Toolbar", "desc" : "A toolbar for this panel", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "region", "type" : "String", - "desc" : "t) which region to put this panel on (when used with xtype constructors)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [ - "center", - "north", - "south", - "east", - "west" - ] + "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)", + "memberOf" : "" }, { "name" : "content", "type" : "String", "desc" : "Raw content to fill content panel with (uses setContent on construction.)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "" + }, + { + "name" : "menu", + "type" : "Roo.menu.Menu", + "desc" : "popup menu", + "memberOf" : "" }, { "name" : "title", "type" : "String", "desc" : "The title for this panel", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "Extra style to add to the content panel", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "autoCreate", - "type" : "Boolean/Object", + "type" : "Boolean|Object", "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "fitContainer", "type" : "Boolean", "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "closable", "type" : "Boolean", "desc" : "True if the panel can be closed/removed", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "params", - "type" : "String/Object", + "type" : "String|Object", "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "adjustments", "type" : "Array", "desc" : "Values to add to the width/height when doing a {@link #fitToFrame} (default is [0, 0])", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "url", "type" : "String", "desc" : "Calls {@link #setUrl} with this value", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "resizeEl", - "type" : "String/HTMLElement/Element", + "type" : "String|HTMLElement|Element", "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "load", + "type" : "function", "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.", + "sig" : "(url, params, callback, discardUrl)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "url", @@ -214,15 +204,20 @@ }, { "name" : "getUpdateManager", + "type" : "function", "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -234,15 +229,20 @@ }, { "name" : "isClosable", + "type" : "function", "desc" : "Returns true is this panel was configured to be closable", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -254,29 +254,39 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Destroys this panel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getEl", + "type" : "function", "desc" : "Returns this panel's element - used by regiosn to add.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -288,15 +298,20 @@ }, { "name" : "setContent", + "type" : "function", "desc" : "Updates this panel's element", + "sig" : "(content, loadScripts)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "content", @@ -315,15 +330,20 @@ }, { "name" : "getId", + "type" : "function", "desc" : "Returns this panel's id", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -335,15 +355,20 @@ }, { "name" : "addxtype", + "type" : "function", "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n
\n\nlayout.addxtype({\n       xtype : 'Form',\n       items: [ .... ]\n   }\n);\n\n
", + "sig" : "(cfg)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cfg", @@ -356,29 +381,39 @@ }, { "name" : "refresh", + "type" : "function", "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getTitle", + "type" : "function", "desc" : "Returns this panel's title", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -390,15 +425,20 @@ }, { "name" : "setTitle", + "type" : "function", "desc" : "Set this panel's title", + "sig" : "(title)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "title", @@ -411,15 +451,20 @@ }, { "name" : "getToolbar", + "type" : "function", "desc" : "Returns the toolbar for this Panel if one was configured.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -431,15 +476,20 @@ }, { "name" : "setUrl", + "type" : "function", "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.", + "sig" : "(url, params, loadOnce)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "url", @@ -470,29 +520,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -523,15 +583,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -556,15 +621,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -577,15 +647,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -598,15 +673,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -631,15 +711,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -664,15 +749,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -691,15 +781,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -724,15 +819,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -765,8 +865,10 @@ "events" : [ { "name" : "deactivate", + "type" : "function", "desc" : "Fires when this panel is activated.", - "memberOf" : "Roo.ContentPanel", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -783,8 +885,10 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires when this panel is resized if fitToFrame is true.", - "memberOf" : "Roo.ContentPanel", + "sig" : "function (_self, width, height)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -813,8 +917,10 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires when this tab is created", - "memberOf" : "Roo.ContentPanel", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -831,8 +937,10 @@ }, { "name" : "activate", + "type" : "function", "desc" : "Fires when this panel is activated.", - "memberOf" : "Roo.ContentPanel", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.DDView.json b/docs/symbols/Roo.DDView.json index 5d0fada021..7d88159e22 100644 --- a/docs/symbols/Roo.DDView.json +++ b/docs/symbols/Roo.DDView.json @@ -31,62 +31,70 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "dropGroup", "type" : "String/Array", "desc" : "The ddgroup name(s) for the View's DropZone.", - "memberOf" : "Roo.DDView", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowCopy", "type" : "Boolean", "desc" : "Causes ctrl/drag operations to copy nodes rather than move.", - "memberOf" : "Roo.DDView", - "optvals" : [] + "memberOf" : "" }, { "name" : "copy", "type" : "Boolean", "desc" : "Causes drag operations to copy nodes rather than move.", - "memberOf" : "Roo.DDView", - "optvals" : [] + "memberOf" : "" }, { "name" : "dragGroup", "type" : "String/Array", "desc" : "The ddgroup name(s) for the View's DragZone.", - "memberOf" : "Roo.DDView", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "getDropPoint", + "type" : "function", "desc" : "Decide whether to drop above or below a View node.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DDView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getValue", + "type" : "function", "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DDView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -98,15 +106,20 @@ }, { "name" : "setDeletable", + "type" : "function", "desc" : "Utility method. Add a delete option to the DDView's context menu.", + "sig" : "(imageUrl)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DDView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "imageUrl", @@ -119,99 +132,134 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Loads the View from a JSON string representing the Records to put into the Store.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DDView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getTargetFromEvent", + "type" : "function", "desc" : "Part of the Roo.dd.DropZone interface. If no target node is found, the\n\twhole Element becomes the target, and this causes the drop gesture to append.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DDView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onDblClick", + "type" : "function", "desc" : "Double click fires the event, but also, if this is draggable, and there is only one other\n\trelated DropZone, it transfers the selected node.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DDView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getDragData", + "type" : "function", "desc" : "Create the drag data which consists of an object which has the property \"ddel\" as\n\tthe drag proxy element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DDView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setDraggable", + "type" : "function", "desc" : "Specify to which ddGroup items in this DDView may be dragged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DDView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getName", + "type" : "function", "desc" : "Allows this class to be an Roo.form.Field so it can be found using {@link Roo.form.BasicForm#findField}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DDView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "remove", + "type" : "function", "desc" : "Remove {@link Roo.data.Record}s at the specified indices.", + "sig" : "(selectedIndices)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DDView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectedIndices", @@ -224,29 +272,39 @@ }, { "name" : "getContextMenu", + "type" : "function", "desc" : "Return the context menu for this DDView.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DDView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setDroppable", + "type" : "function", "desc" : "Specify from which ddGroup this DDView accepts drops.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DDView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] } diff --git a/docs/symbols/Roo.DatePicker.json b/docs/symbols/Roo.DatePicker.json index d92804bdfe..00f5ef28e4 100644 --- a/docs/symbols/Roo.DatePicker.json +++ b/docs/symbols/Roo.DatePicker.json @@ -22,205 +22,183 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "startDay", "type" : "Number", "desc" : "Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "monthYearText", "type" : "String", "desc" : "The header month selector tooltip (defaults to 'Choose a month (Control+Up/Down to move years)')", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "monthNames", "type" : "Array", "desc" : "An array of textual month names which can be overriden for localization support (defaults to Date.monthNames)", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "format", "type" : "String", "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "nextText", "type" : "String", "desc" : "The next month navigation button tooltip (defaults to 'Next Month (Control+Right)')", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "maxText", "type" : "String", "desc" : "The error text to display if the maxDate validation fails (defaults to \"This date is after the maximum date\")", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "constrainToViewport", "type" : "Boolean", "desc" : "True to constrain the date picker to the viewport (defaults to true)", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "minText", "type" : "String", "desc" : "The error text to display if the minDate validation fails (defaults to \"This date is before the minimum date\")", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "disabledDatesText", "type" : "String", "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to \"\")", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "todayTip", "type" : "String", "desc" : "The tooltip to display for the button that selects the current date (defaults to \"{current date} (Spacebar)\")", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "todayText", "type" : "String", "desc" : "The text to display on the button that selects the current date (defaults to \"Today\")", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "cancelText", "type" : "String", "desc" : "The text to display on the cancel button", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "showClear", "type" : "Bool", "desc" : "Show a clear button (usefull for date form elements that can be blank.)", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "prevText", "type" : "String", "desc" : "The previous month navigation button tooltip (defaults to 'Previous Month (Control+Left)')", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "dayNames", "type" : "Array", "desc" : "An array of textual day names which can be overriden for localization support (defaults to Date.dayNames)", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "disabledDaysText", "type" : "String", "desc" : "The tooltip to display when the date falls on a disabled day (defaults to \"\")", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "disabledDatesRE", "type" : "RegExp", "desc" : "JavaScript regular expression used to disable a pattern of dates (defaults to null)", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "minDate", "type" : "Date", "desc" : "Minimum allowable date (JavaScript date object, defaults to null)", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "disabledDays", "type" : "Array", "desc" : "An array of days to disable, 0-based. For example, [0, 6] disables Sunday and Saturday (defaults to null).", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "okText", "type" : "String", "desc" : "The text to display on the ok button", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "maxDate", "type" : "Date", "desc" : "Maximum allowable date (JavaScript date object, defaults to null)", - "memberOf" : "Roo.DatePicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "getValue", + "type" : "function", "desc" : "Gets the current selected value of the date field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DatePicker", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -232,15 +210,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets the value of the date field", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DatePicker", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -253,15 +236,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -273,15 +261,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -294,43 +287,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -343,15 +351,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -363,15 +376,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -390,15 +408,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -410,15 +433,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -430,15 +458,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -457,15 +490,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -477,15 +515,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -497,29 +540,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -550,15 +603,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -583,15 +641,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -604,15 +667,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -625,15 +693,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -658,15 +731,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -691,15 +769,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -718,15 +801,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -751,15 +839,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -792,8 +885,10 @@ "events" : [ { "name" : "select", + "type" : "function", "desc" : "Fires when a date is selected", - "memberOf" : "Roo.DatePicker", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -816,8 +911,10 @@ }, { "name" : "monthchange", + "type" : "function", "desc" : "Fires when the displayed month changes", - "memberOf" : "Roo.DatePicker", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -840,7 +937,9 @@ }, { "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" : "", @@ -858,7 +957,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -876,7 +977,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -894,7 +997,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -912,7 +1017,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -930,7 +1037,9 @@ }, { "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" : "", @@ -948,7 +1057,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -966,7 +1077,9 @@ }, { "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" : "", @@ -984,7 +1097,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1002,7 +1117,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.DialogManager.json b/docs/symbols/Roo.DialogManager.json index 5d50fa52fe..69d8964de8 100644 --- a/docs/symbols/Roo.DialogManager.json +++ b/docs/symbols/Roo.DialogManager.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "bringToFront", + "type" : "function", "desc" : "Brings the specified dialog to the front", + "sig" : "(dlg)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DialogManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "dlg", @@ -43,15 +50,20 @@ }, { "name" : "sendToBack", + "type" : "function", "desc" : "Sends the specified dialog to the back", + "sig" : "(dlg)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DialogManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "dlg", @@ -70,29 +82,39 @@ }, { "name" : "hideAll", + "type" : "function", "desc" : "Hides all dialogs", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DialogManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "get", + "type" : "function", "desc" : "Gets a registered dialog by id", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DialogManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", diff --git a/docs/symbols/Roo.Document.json b/docs/symbols/Roo.Document.json index aadded8de3..77439be3b1 100644 --- a/docs/symbols/Roo.Document.json +++ b/docs/symbols/Roo.Document.json @@ -21,41 +21,52 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" } ], "methods" : [ { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -86,15 +97,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -119,15 +135,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -140,15 +161,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -161,15 +187,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -194,15 +225,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -227,15 +263,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -254,15 +295,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -287,15 +333,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", diff --git a/docs/symbols/Roo.DomHelper.json b/docs/symbols/Roo.DomHelper.json index 4a05b33f27..1fe38ca9eb 100644 --- a/docs/symbols/Roo.DomHelper.json +++ b/docs/symbols/Roo.DomHelper.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "insertHtml", + "type" : "function", "desc" : "Inserts an HTML fragment into the Dom", + "sig" : "(where, el, html)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DomHelper", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "where", @@ -55,15 +62,20 @@ }, { "name" : "createTemplate", + "type" : "function", "desc" : "Creates a new Roo.DomHelper.Template from the Dom object spec", + "sig" : "(o)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DomHelper", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -82,15 +94,20 @@ }, { "name" : "insertAfter", + "type" : "function", "desc" : "Creates new Dom element(s) and inserts them after el", + "sig" : "(el, o, returnElement)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DomHelper", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -121,15 +138,20 @@ }, { "name" : "insertFirst", + "type" : "function", "desc" : "Creates new Dom element(s) and inserts them as the first child of el", + "sig" : "(el, o, returnElement)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DomHelper", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -160,15 +182,20 @@ }, { "name" : "append", + "type" : "function", "desc" : "Creates new Dom element(s) and appends them to el", + "sig" : "(el, o, returnElement)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DomHelper", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -199,15 +226,20 @@ }, { "name" : "applyStyles", + "type" : "function", "desc" : "Applies a style specification to an element", + "sig" : "(el, styles)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DomHelper", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -226,15 +258,20 @@ }, { "name" : "markup", + "type" : "function", "desc" : "Returns the markup for the passed Element(s) config", + "sig" : "(o)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DomHelper", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -253,15 +290,20 @@ }, { "name" : "overwrite", + "type" : "function", "desc" : "Creates new Dom element(s) and overwrites the contents of el with them", + "sig" : "(el, o, returnElement)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DomHelper", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -292,15 +334,20 @@ }, { "name" : "insertBefore", + "type" : "function", "desc" : "Creates new Dom element(s) and inserts them before el", + "sig" : "(el, o, returnElement)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DomHelper", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", diff --git a/docs/symbols/Roo.DomQuery.json b/docs/symbols/Roo.DomQuery.json index 8d8a805bfb..704faaee3b 100644 --- a/docs/symbols/Roo.DomQuery.json +++ b/docs/symbols/Roo.DomQuery.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "selectNumber", + "type" : "function", "desc" : "Selects the value of a node, parsing integers and floats.", + "sig" : "(selector, root, defaultValue)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DomQuery", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -55,15 +62,20 @@ }, { "name" : "is", + "type" : "function", "desc" : "Returns true if the passed element(s) match the passed simple selector (e.g. div.some-class or span:first-child)", + "sig" : "(el, selector)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DomQuery", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -88,15 +100,20 @@ }, { "name" : "selectValue", + "type" : "function", "desc" : "Selects the value of a node, optionally replacing null with the defaultValue.", + "sig" : "(selector, root, defaultValue)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DomQuery", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -121,15 +138,20 @@ }, { "name" : "filter", + "type" : "function", "desc" : "Filters an array of elements to only include matches of a simple selector (e.g. div.some-class or span:first-child)", + "sig" : "(el, selector, nonMatches)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DomQuery", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -160,15 +182,20 @@ }, { "name" : "select", + "type" : "function", "desc" : "Selects a group of elements.", + "sig" : "(selector, root)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DomQuery", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -193,15 +220,20 @@ }, { "name" : "selectNode", + "type" : "function", "desc" : "Selects a single element.", + "sig" : "(selector, root)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DomQuery", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -226,15 +258,20 @@ }, { "name" : "compile", + "type" : "function", "desc" : "Compiles a selector/xpath query into a reusable function. The returned function\ntakes one parameter \"root\" (optional), which is the context node from where the query should start.", + "sig" : "(selector, type)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DomQuery", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", diff --git a/docs/symbols/Roo.DomTemplate.json b/docs/symbols/Roo.DomTemplate.json index bfd0e5d085..ca69260821 100644 --- a/docs/symbols/Roo.DomTemplate.json +++ b/docs/symbols/Roo.DomTemplate.json @@ -14,41 +14,45 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "onLoad", "type" : "Function", "desc" : "Called after the template has been loaded and complied (usually from a remove source)", - "memberOf" : "Roo.Template", - "optvals" : [] + "memberOf" : "Roo.Template" }, { "name" : "html", "type" : "String", "desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")", - "memberOf" : "Roo.Template", - "optvals" : [] + "memberOf" : "Roo.Template" }, { "name" : "url", "type" : "String", "desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n it should be fixed so that template is observable...", - "memberOf" : "Roo.Template", - "optvals" : [] + "memberOf" : "Roo.Template" } ], "methods" : [ { "name" : "applySubTemplate", + "type" : "function", "desc" : "same as applyTemplate, except it's done to one of the subTemplates\nwhen using named templates, you can do:\n\nvar str = pl.applySubTemplate('your-name', values);", + "sig" : "(id, values, parent)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DomTemplate", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -73,43 +77,58 @@ }, { "name" : "compile", + "type" : "function", "desc" : "compile the template\n\nThis is not recursive, so I'm not sure how nested templates are really going to be handled..", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DomTemplate", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "compileTpl", + "type" : "function", "desc" : "Compile a segment of the template into a 'sub-template'", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.DomTemplate", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "insertFirst", + "type" : "function", "desc" : "Applies the supplied values to the template and inserts the new node(s) as the first child of el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -140,15 +159,20 @@ }, { "name" : "overwrite", + "type" : "function", "desc" : "Applies the supplied values to the template and overwrites the content of el with the new node(s).", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -179,15 +203,20 @@ }, { "name" : "insertBefore", + "type" : "function", "desc" : "Applies the supplied values to the template and inserts the new node(s) before el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -218,15 +247,20 @@ }, { "name" : "applyTemplate", + "type" : "function", "desc" : "Returns an HTML fragment of this template with the specified values applied.", + "sig" : "(values)", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "values", @@ -245,15 +279,20 @@ }, { "name" : "set", + "type" : "function", "desc" : "Sets the HTML used as the template and optionally compiles it.", + "sig" : "(html, compile)", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "html", @@ -278,15 +317,20 @@ }, { "name" : "from", + "type" : "function", "desc" : "Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML.", + "sig" : "(el)", + "static" : true, + "memberOf" : "Roo.Template", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -299,15 +343,20 @@ }, { "name" : "insertAfter", + "type" : "function", "desc" : "Applies the supplied values to the template and inserts the new node(s) after el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -338,15 +387,20 @@ }, { "name" : "append", + "type" : "function", "desc" : "Applies the supplied values to the template and appends the new node(s) to el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -377,15 +431,20 @@ }, { "name" : "apply", + "type" : "function", "desc" : "Alias for {@link #applyTemplate}", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] } diff --git a/docs/symbols/Roo.Editor.json b/docs/symbols/Roo.Editor.json index b6d5ac386e..b8c61f3e0c 100644 --- a/docs/symbols/Roo.Editor.json +++ b/docs/symbols/Roo.Editor.json @@ -28,135 +28,123 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "hideEl", "type" : "Boolean", "desc" : "False to keep the bound element visible while the editor is displayed (defaults to true)", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "" }, { "name" : "alignment", "type" : "String", "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to \"c-c?\").", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "" }, { "name" : "constrain", "type" : "Boolean", "desc" : "True to constrain the editor to the viewport", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "" }, { "name" : "shadow", "type" : "Boolean/String", "desc" : "\"sides\" for sides/bottom only, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"frame\")", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "value", "type" : "Mixed", "desc" : "The data value of the underlying field (defaults to \"\")", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cancelOnEsc", "type" : "Boolean", "desc" : "True to cancel the edit when the escape key is pressed (defaults to false)", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "completeOnEnter", "type" : "Boolean", "desc" : "True to complete the edit when the enter key is pressed (defaults to false)", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "" }, { "name" : "revertInvalid", "type" : "Boolean", "desc" : "True to automatically revert the field value and cancel the edit when the user completes an edit and the field\nvalidation fails (defaults to true)", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "ignoreNoChange", "type" : "Boolean", "desc" : "True to skip the the edit completion process (no save, no events fired) if the user completes an edit and\nthe value has not changed (defaults to false). Applies only to string values - edits for other data types\nwill never be ignored.", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "" }, { "name" : "autosize", "type" : "Boolean/String", "desc" : "True for the editor to automatically adopt the size of the underlying field, \"width\" to adopt the width only,\nor \"height\" to adopt the height only (defaults to false)", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "" }, { "name" : "updateEl", "type" : "Boolean", "desc" : "True to update the innerHTML of the bound element when the update completes (defaults to false)", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "cancelEdit", + "type" : "function", "desc" : "Cancels the editing process and hides the editor without persisting any changes. The field value will be\nreverted to the original starting value.", + "sig" : "(remainVisible)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "remainVisible", @@ -169,15 +157,20 @@ }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the height and width of this editor.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -196,29 +189,39 @@ }, { "name" : "realign", + "type" : "function", "desc" : "Realigns the editor to the bound field based on the current alignment config value.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getValue", + "type" : "function", "desc" : "Gets the data value of the editor", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -230,15 +233,20 @@ }, { "name" : "completeEdit", + "type" : "function", "desc" : "Ends the editing process, persists the changed value to the underlying field, and hides the editor.", + "sig" : "(remainVisible)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "remainVisible", @@ -251,15 +259,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets the data value of the editor", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -272,15 +285,20 @@ }, { "name" : "startEdit", + "type" : "function", "desc" : "Starts the editing process and shows the editor.", + "sig" : "(el, value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -299,15 +317,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -319,15 +342,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -340,43 +368,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -389,15 +432,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -409,15 +457,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -436,15 +489,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -456,15 +514,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -476,15 +539,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -503,15 +571,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -523,15 +596,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -543,29 +621,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -596,15 +684,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -629,15 +722,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -650,15 +748,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -671,15 +774,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -704,15 +812,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -737,15 +850,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -764,15 +882,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -797,15 +920,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -838,8 +966,10 @@ "events" : [ { "name" : "beforestartedit", + "type" : "function", "desc" : "Fires when editing is initiated, but before the value changes. Editing can be canceled by returning\nfalse from the handler of this event.", - "memberOf" : "Roo.Editor", + "sig" : "function (_self, boundEl, value)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -868,8 +998,10 @@ }, { "name" : "beforecomplete", + "type" : "function", "desc" : "Fires after a change has been made to the field, but before the change is reflected in the underlying\nfield. Saving the change to the field can be canceled by returning false from the handler of this event.\nNote that if the value has not changed and ignoreNoChange = true, the editing will still end but this\nevent will not fire since no edit actually occurred.", - "memberOf" : "Roo.Editor", + "sig" : "function (_self, value, startValue)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -898,8 +1030,10 @@ }, { "name" : "complete", + "type" : "function", "desc" : "Fires after editing is complete and any changed value has been written to the underlying field.", - "memberOf" : "Roo.Editor", + "sig" : "function (_self, value, startValue)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -928,8 +1062,10 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", - "memberOf" : "Roo.Editor", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -952,8 +1088,10 @@ }, { "name" : "startedit", + "type" : "function", "desc" : "Fires when this editor is displayed", - "memberOf" : "Roo.Editor", + "sig" : "function (boundEl, value)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -976,7 +1114,9 @@ }, { "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" : "", @@ -994,7 +1134,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1012,7 +1154,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1030,7 +1174,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1048,7 +1194,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1066,7 +1214,9 @@ }, { "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" : "", @@ -1084,7 +1234,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1102,7 +1254,9 @@ }, { "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" : "", @@ -1120,7 +1274,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1138,7 +1294,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.Element.json b/docs/symbols/Roo.Element.json index 28c3b8d44a..3307a794b0 100644 --- a/docs/symbols/Roo.Element.json +++ b/docs/symbols/Roo.Element.json @@ -25,19 +25,26 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "getCenterXY", + "type" : "function", "desc" : "Calculates the x, y to center this element on the screen", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -49,15 +56,20 @@ }, { "name" : "getScroll", + "type" : "function", "desc" : "Returns the current scroll position of the element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -69,15 +81,20 @@ }, { "name" : "createShim", + "type" : "function", "desc" : "Creates an iframe shim for this element to keep selects and other windowed objects from\nshowing through.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -89,15 +106,20 @@ }, { "name" : "scrollTo", + "type" : "function", "desc" : "Scrolls this element the specified scroll point. It does NOT do bounds checking so if you scroll to a weird value it will try to do it. For auto bounds checking, use scroll().", + "sig" : "(side, value, animate)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "side", @@ -128,15 +150,20 @@ }, { "name" : "removeAllListeners", + "type" : "function", "desc" : "Removes all previous added listeners from this element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -148,15 +175,20 @@ }, { "name" : "setStyle", + "type" : "function", "desc" : "Wrapper for setting style properties, also takes single object parameter of multiple styles.", + "sig" : "(property, value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "property", @@ -181,15 +213,20 @@ }, { "name" : "on", + "type" : "function", "desc" : "Appends an event handler (Shorthand for addListener)", + "sig" : "(eventName, fn, scope, options)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -220,15 +257,20 @@ }, { "name" : "addClassOnClick", + "type" : "function", "desc" : "Sets up event handlers to add and remove a css class when the mouse is down and then up on this element (a click effect)", + "sig" : "(className)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "className", @@ -247,15 +289,20 @@ }, { "name" : "getBorderWidth", + "type" : "function", "desc" : "Gets the width of the border(s) for the specified side(s)", + "sig" : "(side)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "side", @@ -274,15 +321,20 @@ }, { "name" : "scroll", + "type" : "function", "desc" : "Scrolls this element the specified direction. Does bounds checking to make sure the scroll is\nwithin this element's scrollable range.", + "sig" : "(direction, distance, animate)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "direction", @@ -313,15 +365,20 @@ }, { "name" : "addKeyMap", + "type" : "function", "desc" : "Creates a KeyMap for this element", + "sig" : "(config)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -340,15 +397,20 @@ }, { "name" : "createChild", + "type" : "function", "desc" : "Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element.", + "sig" : "(config, insertBefore, returnDom)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -379,15 +441,20 @@ }, { "name" : "addClass", + "type" : "function", "desc" : "Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.", + "sig" : "(className)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "className", @@ -406,15 +473,20 @@ }, { "name" : "attr", + "type" : "function", "desc" : "Sets or Returns the value the dom attribute value", + "sig" : "(name, value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "name", @@ -439,15 +511,20 @@ }, { "name" : "setOpacity", + "type" : "function", "desc" : "Set the opacity of the element", + "sig" : "(opacity, animate)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "opacity", @@ -472,15 +549,20 @@ }, { "name" : "setSize", + "type" : "function", "desc" : "Set the size of the element. If animation is true, both width an height will be animated concurrently.", + "sig" : "(width, height, animate)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -511,15 +593,20 @@ }, { "name" : "un", + "type" : "function", "desc" : "Removes an event handler from this element (shorthand for removeListener)", + "sig" : "(eventName, fn)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -544,15 +631,20 @@ }, { "name" : "up", + "type" : "function", "desc" : "Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first-child).\nThis is a shortcut for findParentNode() that always returns an Roo.Element.", + "sig" : "(selector, maxDepth)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -577,15 +669,20 @@ }, { "name" : "repaint", + "type" : "function", "desc" : "Forces the browser to repaint this element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -597,15 +694,20 @@ }, { "name" : "translatePoints", + "type" : "function", "desc" : "Translates the passed page coordinates into left/top css values for this element", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -630,15 +732,20 @@ }, { "name" : "createProxy", + "type" : "function", "desc" : "Creates a proxy element of this element", + "sig" : "(config, renderTo, matchBox)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -669,15 +776,20 @@ }, { "name" : "down", + "type" : "function", "desc" : "Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id).", + "sig" : "(selector, returnDom)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -702,15 +814,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Return a box {x, y, width, height} that can be used to set another elements\nsize/location to match this element.", + "sig" : "(contentBox, local)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "contentBox", @@ -735,15 +852,20 @@ }, { "name" : "toggle", + "type" : "function", "desc" : "Toggles the element's visibility or display, depending on visibility mode.", + "sig" : "(animate)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "animate", @@ -762,15 +884,20 @@ }, { "name" : "setBounds", + "type" : "function", "desc" : "Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated concurrently.", + "sig" : "(x, y, width, height, animate)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -813,15 +940,20 @@ }, { "name" : "getX", + "type" : "function", "desc" : "Gets the current X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -833,15 +965,20 @@ }, { "name" : "getY", + "type" : "function", "desc" : "Gets the current Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -853,15 +990,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Tries to focus the element. Any exceptions are caught and ignored.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -873,15 +1015,20 @@ }, { "name" : "get", + "type" : "function", "desc" : "Static method to retrieve Element objects. Uses simple caching to consistently return the same object.\nAutomatically fixes if an object was recreated with the same id via AJAX or DOM.", + "sig" : "(el)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -900,15 +1047,20 @@ }, { "name" : "autoHeight", + "type" : "function", "desc" : "Measures the element's content height and updates height to match. Note: this function uses setTimeout so\nthe new height may not be available immediately.", + "sig" : "(animate, duration, onComplete, easing)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "animate", @@ -945,15 +1097,20 @@ }, { "name" : "scrollIntoView", + "type" : "function", "desc" : "Scrolls this element into view within the passed container.", + "sig" : "(container, hscroll)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -978,15 +1135,20 @@ }, { "name" : "getAlignToXY", + "type" : "function", "desc" : "Gets the x,y coordinates to align this element with another element. See {@link #alignTo} for more info on the\nsupported position values.", + "sig" : "(element, position, offsets)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "element", @@ -1017,15 +1179,20 @@ }, { "name" : "clearOpacity", + "type" : "function", "desc" : "Clears any opacity settings from this element. Required in some cases for IE.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1037,15 +1204,20 @@ }, { "name" : "setPositioning", + "type" : "function", "desc" : "Set positioning with an object returned by getPositioning().", + "sig" : "(posCfg)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "posCfg", @@ -1064,15 +1236,20 @@ }, { "name" : "getMargins", + "type" : "function", "desc" : "Returns an object with properties top, left, right and bottom representing the margins of this element unless sides is passed,\nthen it returns the calculated width of the sides (see getPadding)", + "sig" : "(sides)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sides", @@ -1091,15 +1268,20 @@ }, { "name" : "setRegion", + "type" : "function", "desc" : "Sets the element's position and size the the specified region. If animation is true then width, height, x and y will be animated concurrently.", + "sig" : "(region, animate)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "region", @@ -1124,15 +1306,20 @@ }, { "name" : "getAttributeNS", + "type" : "function", "desc" : "Returns the value of a namespaced attribute from the element's underlying DOM node.", + "sig" : "(namespace, name)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "namespace", @@ -1157,15 +1344,20 @@ }, { "name" : "setLeft", + "type" : "function", "desc" : "Sets the element's left position directly using CSS style (instead of {@link #setX}).", + "sig" : "(left)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -1184,15 +1376,20 @@ }, { "name" : "load", + "type" : "function", "desc" : "Direct access to the UpdateManager update() method (takes the same parameters).", + "sig" : "(url, params, callback, discardUrl)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "url", @@ -1229,15 +1426,20 @@ }, { "name" : "replaceClass", + "type" : "function", "desc" : "Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added.", + "sig" : "(oldClassName, newClassName)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "oldClassName", @@ -1262,15 +1464,20 @@ }, { "name" : "initDDTarget", + "type" : "function", "desc" : "Initializes a {@link Roo.dd.DDTarget} object for this element.", + "sig" : "(group, config, overrides)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "group", @@ -1301,15 +1508,20 @@ }, { "name" : "setHeight", + "type" : "function", "desc" : "Set the height of the element", + "sig" : "(height, animate)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "height", @@ -1334,15 +1546,20 @@ }, { "name" : "clean", + "type" : "function", "desc" : "Removes worthless text nodes", + "sig" : "(forceReclean)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "forceReclean", @@ -1355,15 +1572,20 @@ }, { "name" : "getPositioning", + "type" : "function", "desc" : "Gets an object with all CSS positioning properties. Useful along with setPostioning to get\nsnapshot before performing an update and then restoring the element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1375,15 +1597,20 @@ }, { "name" : "update", + "type" : "function", "desc" : "Update the innerHTML of this element, optionally searching for and processing scripts", + "sig" : "(html, loadScripts, callback)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "html", @@ -1414,15 +1641,20 @@ }, { "name" : "contains", + "type" : "function", "desc" : "Returns true if this element is an ancestor of the passed element", + "sig" : "(el)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -1441,15 +1673,20 @@ }, { "name" : "appendChild", + "type" : "function", "desc" : "Appends the passed element(s) to this element", + "sig" : "(el)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -1468,15 +1705,20 @@ }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the value of the \"value\" attribute", + "sig" : "(asNumber)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "asNumber", @@ -1495,15 +1737,20 @@ }, { "name" : "getRegion", + "type" : "function", "desc" : "Returns the region of the given element.\nThe element must be part of the DOM tree to have a region (display:none or elements not appended return false).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1515,15 +1762,20 @@ }, { "name" : "anchorTo", + "type" : "function", "desc" : "Anchors an element to another element and realigns it when the window is resized.", + "sig" : "(element, position, offsets, animate, monitorScroll, callback)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "element", @@ -1572,15 +1824,20 @@ }, { "name" : "removeClass", + "type" : "function", "desc" : "Removes one or more CSS classes from the element.", + "sig" : "(className)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "className", @@ -1599,15 +1856,20 @@ }, { "name" : "radioClass", + "type" : "function", "desc" : "Adds one or more CSS classes to this element and removes the same class(es) from all siblings.", + "sig" : "(className)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "className", @@ -1626,15 +1888,20 @@ }, { "name" : "getWidth", + "type" : "function", "desc" : "Returns the offset width of the element", + "sig" : "(contentWidth)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "contentWidth", @@ -1653,15 +1920,20 @@ }, { "name" : "insertBefore", + "type" : "function", "desc" : "Inserts this element before the passed element in the DOM", + "sig" : "(el)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -1680,15 +1952,20 @@ }, { "name" : "getHeight", + "type" : "function", "desc" : "Returns the offset height of the element", + "sig" : "(contentHeight)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "contentHeight", @@ -1707,15 +1984,20 @@ }, { "name" : "setTop", + "type" : "function", "desc" : "Sets the element's top position directly using CSS style (instead of {@link #setY}).", + "sig" : "(top)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "top", @@ -1734,15 +2016,20 @@ }, { "name" : "toggleClass", + "type" : "function", "desc" : "Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it).", + "sig" : "(className)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "className", @@ -1761,15 +2048,20 @@ }, { "name" : "wrap", + "type" : "function", "desc" : "Creates and wraps this element with another element", + "sig" : "(config, returnDom)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -1794,15 +2086,20 @@ }, { "name" : "setVisible", + "type" : "function", "desc" : "Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use\nthe display property to hide the element, otherwise it uses visibility. The default is to hide and show using the visibility property.", + "sig" : "(visible, animate)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1827,15 +2124,20 @@ }, { "name" : "addListener", + "type" : "function", "desc" : "Appends an event handler", + "sig" : "(eventName, fn, scope, options)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1866,15 +2168,20 @@ }, { "name" : "setWidth", + "type" : "function", "desc" : "Set the width of the element", + "sig" : "(width, animate)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -1899,15 +2206,20 @@ }, { "name" : "center", + "type" : "function", "desc" : "Centers the Element in either the viewport, or another Element.", + "sig" : "(centerIn)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "centerIn", @@ -1920,15 +2232,20 @@ }, { "name" : "isVisible", + "type" : "function", "desc" : "Checks whether the element is currently visible using both visibility and display properties.", + "sig" : "(deep)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "deep", @@ -1947,15 +2264,20 @@ }, { "name" : "findParent", + "type" : "function", "desc" : "Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)", + "sig" : "(selector, maxDepth, returnEl)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -1986,15 +2308,20 @@ }, { "name" : "addKeyListener", + "type" : "function", "desc" : "Convenience method for constructing a KeyMap", + "sig" : "(key, fn, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "key", @@ -2025,15 +2352,20 @@ }, { "name" : "swallowEvent", + "type" : "function", "desc" : "Stops the specified event from bubbling and optionally prevents the default action", + "sig" : "(eventName, preventDefault)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -2058,15 +2390,20 @@ }, { "name" : "getStyles", + "type" : "function", "desc" : "Returns an object with properties matching the styles requested.\nFor example, el.getStyles('color', 'font-size', 'width') might return\n{'color': '#FFFFFF', 'font-size': '13px', 'width': '100px'}.", + "sig" : "(style1, style2)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "style1", @@ -2091,15 +2428,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Returns the size of the element.", + "sig" : "(contentSize)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "contentSize", @@ -2118,15 +2460,20 @@ }, { "name" : "endMeasure", + "type" : "function", "desc" : "Restores displays to before beginMeasure was called", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -2138,15 +2485,20 @@ }, { "name" : "getViewSize", + "type" : "function", "desc" : "Returns the width and height of the viewport.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -2158,15 +2510,20 @@ }, { "name" : "addClassOnFocus", + "type" : "function", "desc" : "Sets up event handlers to add and remove a css class when this element has the focus", + "sig" : "(className)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "className", @@ -2185,15 +2542,20 @@ }, { "name" : "alignTo", + "type" : "function", "desc" : "Aligns this element with another element relative to the specified anchor points. If the other element is the\ndocument it aligns it to the viewport.\nThe position parameter is optional, and can be specified in any one of the following formats:\n\nIn addition to the anchor points, the position parameter also supports the \"?\" character. If \"?\" is passed at the end of\nthe position string, the element will attempt to align as specified, but the position will be adjusted to constrain to\nthe viewport if necessary. Note that the element being aligned might be swapped to align to a different position than\nthat specified in order to enforce the viewport constraints.\nFollowing are all of the supported anchor positions:\n
\n    Value  Description\n    -----  -----------------------------\n    tl     The top left corner (default)\n    t      The center of the top edge\n    tr     The top right corner\n    l      The center of the left edge\n    c      In the center of the element\n    r      The center of the right edge\n    bl     The bottom left corner\n    b      The center of the bottom edge\n    br     The bottom right corner\n    
\n Example Usage:\n
\n    // align el to other-el using the default positioning (\"tl-bl\", non-constrained)\n    el.alignTo(\"other-el\");\n\n    // align the top left corner of el with the top right corner of other-el (constrained to viewport)\n    el.alignTo(\"other-el\", \"tr?\");\n\n    // align the bottom right corner of el with the center left edge of other-el\n    el.alignTo(\"other-el\", \"br-l?\");\n\n    // align the center of el with the bottom left corner of other-el and\n    // adjust the x position by -6 pixels (and the y position by 0)\n    el.alignTo(\"other-el\", \"c-bl\", [-6, 0]);\n    
", + "sig" : "(element, position, offsets, animate)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "element", @@ -2230,15 +2592,20 @@ }, { "name" : "insertAfter", + "type" : "function", "desc" : "Inserts this element after the passed element in the DOM", + "sig" : "(el)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -2257,15 +2624,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this element - Uses display mode to determine whether to use \"display\" or \"visibility\". See {@link #setVisible}.", + "sig" : "(animate)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "animate", @@ -2284,15 +2656,20 @@ }, { "name" : "setBottom", + "type" : "function", "desc" : "Sets the element's CSS bottom style.", + "sig" : "(bottom)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "bottom", @@ -2311,15 +2688,20 @@ }, { "name" : "clearPositioning", + "type" : "function", "desc" : "Clear positioning back to the default when the document was loaded", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -2338,15 +2720,20 @@ }, { "name" : "isDisplayed", + "type" : "function", "desc" : "Returns true if display is not \"none\"", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -2358,15 +2745,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this element - Uses display mode to determine whether to use \"display\" or \"visibility\". See {@link #setVisible}.", + "sig" : "(animate)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "animate", @@ -2385,15 +2777,20 @@ }, { "name" : "setLeftTop", + "type" : "function", "desc" : "Quick set left and top adding default units", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -2418,15 +2815,20 @@ }, { "name" : "child", + "type" : "function", "desc" : "Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id).", + "sig" : "(selector, returnDom)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -2451,29 +2853,39 @@ }, { "name" : "unmask", + "type" : "function", "desc" : "Removes a previously applied mask. If removeEl is true the mask overlay is destroyed, otherwise\nit is cached for reuse.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "moveTo", + "type" : "function", "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "sig" : "(x, y, animate)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -2504,15 +2916,20 @@ }, { "name" : "addClassOnOver", + "type" : "function", "desc" : "Sets up event handlers to add and remove a css class when the mouse is over this element", + "sig" : "(className, preventFlicker)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "className", @@ -2537,15 +2954,20 @@ }, { "name" : "getLeft", + "type" : "function", "desc" : "Gets the left X coordinate", + "sig" : "(local)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -2564,15 +2986,20 @@ }, { "name" : "isScrollable", + "type" : "function", "desc" : "Returns true if this element is scrollable.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -2584,15 +3011,20 @@ }, { "name" : "boxWrap", + "type" : "function", "desc" : "Wraps the specified element with a special markup/CSS block that renders by default as a gray container with a\ngradient background, rounded corners and a 4-way shadow.", + "sig" : "(class)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "class", @@ -2611,15 +3043,20 @@ }, { "name" : "replace", + "type" : "function", "desc" : "Replaces the passed element with this element", + "sig" : "(el)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -2638,15 +3075,20 @@ }, { "name" : "select", + "type" : "function", "desc" : "Creates a {@link Roo.CompositeElement} for child nodes based on the passed CSS selector (the selector should not contain an id).", + "sig" : "(selector, unique)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -2671,15 +3113,20 @@ }, { "name" : "isMasked", + "type" : "function", "desc" : "Returns true if this element is masked", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -2691,15 +3138,20 @@ }, { "name" : "getUpdateManager", + "type" : "function", "desc" : "Gets this element's UpdateManager", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -2711,15 +3163,20 @@ }, { "name" : "insertHtml", + "type" : "function", "desc" : "Inserts an html fragment into this element", + "sig" : "(where, html, returnEl)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "where", @@ -2750,15 +3207,20 @@ }, { "name" : "mask", + "type" : "function", "desc" : "Puts a mask over this element to disable user interaction. Requires core.css.\nThis method can only be applied to elements which accept child nodes.", + "sig" : "(msg, msgCls)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -2783,15 +3245,20 @@ }, { "name" : "getTop", + "type" : "function", "desc" : "Gets the top Y coordinate", + "sig" : "(local)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -2810,15 +3277,20 @@ }, { "name" : "getBottom", + "type" : "function", "desc" : "Gets the bottom Y coordinate of the element (element Y position + element height)", + "sig" : "(local)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -2837,15 +3309,20 @@ }, { "name" : "getRight", + "type" : "function", "desc" : "Gets the right X coordinate of the element (element X position + element width)", + "sig" : "(local)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -2864,15 +3341,20 @@ }, { "name" : "beginMeasure", + "type" : "function", "desc" : "Temporarily enables offsets (width,height,x,y) for an element with display:none, use endMeasure() when done.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -2884,15 +3366,20 @@ }, { "name" : "appendTo", + "type" : "function", "desc" : "Appends this element to the passed element", + "sig" : "(el)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -2911,15 +3398,20 @@ }, { "name" : "fly", + "type" : "function", "desc" : "Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -\nthe dom node can be overwritten by other code.", + "sig" : "(el, named)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -2944,15 +3436,20 @@ }, { "name" : "hasClass", + "type" : "function", "desc" : "Checks if the specified CSS class exists on this element's DOM node.", + "sig" : "(className)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "className", @@ -2971,29 +3468,39 @@ }, { "name" : "findScrollableParent", + "type" : "function", "desc" : "Looks at the scrollable parent element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "fitToParent", + "type" : "function", "desc" : "Sizes this element to its parent element's dimensions performing\nneccessary box adjustments.", + "sig" : "(monitorResize, targetParent)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "monitorResize", @@ -3018,15 +3525,20 @@ }, { "name" : "setXY", + "type" : "function", "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "sig" : "(pos, animate)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "pos", @@ -3051,15 +3563,20 @@ }, { "name" : "getXY", + "type" : "function", "desc" : "Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -3071,15 +3588,20 @@ }, { "name" : "unselectable", + "type" : "function", "desc" : "Disables text selection for this element (normalized across browsers)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -3091,15 +3613,20 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Tries to blur the element. Any exceptions are caught and ignored.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -3111,15 +3638,20 @@ }, { "name" : "setRight", + "type" : "function", "desc" : "Sets the element's CSS right style.", + "sig" : "(right)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "right", @@ -3138,15 +3670,20 @@ }, { "name" : "findParentNode", + "type" : "function", "desc" : "Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)", + "sig" : "(selector, maxDepth, returnEl)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -3177,15 +3714,20 @@ }, { "name" : "position", + "type" : "function", "desc" : "Initializes positioning on this element. If a desired position is not passed, it will make the\nthe element positioned relative IF it is not already positioned.", + "sig" : "(pos, zIndex, x, y)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "pos", @@ -3216,15 +3758,20 @@ }, { "name" : "getFrameWidth", + "type" : "function", "desc" : "Returns the sum width of the padding and borders for the passed \"sides\". See getBorderWidth()\n for more information about the sides.", + "sig" : "(sides)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sides", @@ -3243,15 +3790,20 @@ }, { "name" : "setLocation", + "type" : "function", "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "sig" : "(x, y, animate)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -3282,15 +3834,20 @@ }, { "name" : "unclip", + "type" : "function", "desc" : "Return clipping (overflow) to original clipping before clip() was called", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -3302,15 +3859,20 @@ }, { "name" : "set", + "type" : "function", "desc" : "Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)", + "sig" : "(o, useSet)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -3335,15 +3897,20 @@ }, { "name" : "setDisplayed", + "type" : "function", "desc" : "Sets the CSS display property. Uses originalDisplay if the specified value is a boolean true.", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -3362,15 +3929,20 @@ }, { "name" : "insertFirst", + "type" : "function", "desc" : "Inserts (or creates) an element (or DomHelper config) as the first child of the this element", + "sig" : "(el)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -3389,15 +3961,20 @@ }, { "name" : "animate", + "type" : "function", "desc" : "Perform animation on this element.", + "sig" : "(args, duration, onComplete, easing, animType)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "args", @@ -3440,15 +4017,20 @@ }, { "name" : "enableDisplayMode", + "type" : "function", "desc" : "Convenience method for setVisibilityMode(Element.DISPLAY)", + "sig" : "(display)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "display", @@ -3467,15 +4049,20 @@ }, { "name" : "getComputedWidth", + "type" : "function", "desc" : "Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders\nwhen needed to simulate offsetWidth when offsets aren't available. This may not work on display:none elements\nif a width has not been set using CSS.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -3487,15 +4074,20 @@ }, { "name" : "clip", + "type" : "function", "desc" : "Store the current overflow setting and clip overflow on the element - use {@link #unclip} to remove", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -3507,15 +4099,20 @@ }, { "name" : "setVisibilityMode", + "type" : "function", "desc" : "Sets the element's visibility mode. When setVisible() is called it\nwill use this to determine whether to set the visibility or the display property.", + "sig" : "(visMode)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visMode", @@ -3534,15 +4131,20 @@ }, { "name" : "getColor", + "type" : "function", "desc" : "Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values\nare convert to standard 6 digit hex color.", + "sig" : "(attr, defaultValue, prefix)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "attr", @@ -3567,15 +4169,20 @@ }, { "name" : "insertSibling", + "type" : "function", "desc" : "Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element", + "sig" : "(el, where, returnDom)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -3606,15 +4213,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes an event handler from this element", + "sig" : "(eventName, fn, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -3645,15 +4257,20 @@ }, { "name" : "applyStyles", + "type" : "function", "desc" : "More flexible version of {@link #setStyle} for setting style properties.", + "sig" : "(styles)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "styles", @@ -3672,15 +4289,20 @@ }, { "name" : "getPrevSibling", + "type" : "function", "desc" : "Gets the previous sibling, skipping text nodes", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -3692,15 +4314,20 @@ }, { "name" : "setBox", + "type" : "function", "desc" : "Sets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x and y will be animated concurrently.", + "sig" : "(box, adjust, animate)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -3731,15 +4358,20 @@ }, { "name" : "initDDProxy", + "type" : "function", "desc" : "Initializes a {@link Roo.dd.DDProxy} object for this element.", + "sig" : "(group, config, overrides)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "group", @@ -3770,15 +4402,20 @@ }, { "name" : "setX", + "type" : "function", "desc" : "Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "sig" : "(The, animate)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "The", @@ -3803,15 +4440,20 @@ }, { "name" : "setY", + "type" : "function", "desc" : "Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "sig" : "(The, animate)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "The", @@ -3836,15 +4478,20 @@ }, { "name" : "query", + "type" : "function", "desc" : "Selects child nodes based on the passed CSS selector (the selector should not contain an id).", + "sig" : "(selector)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -3863,15 +4510,20 @@ }, { "name" : "getAnchorXY", + "type" : "function", "desc" : "Gets the x,y coordinates specified by the anchor position on the element.", + "sig" : "(anchor, size, local)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "anchor", @@ -3902,15 +4554,20 @@ }, { "name" : "initDD", + "type" : "function", "desc" : "Initializes a {@link Roo.dd.DD} drag drop object for this element.", + "sig" : "(group, config, overrides)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "group", @@ -3941,15 +4598,20 @@ }, { "name" : "getComputedHeight", + "type" : "function", "desc" : "Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders\nwhen needed to simulate offsetHeight when offsets aren't available. This may not work on display:none elements\nif a height has not been set using CSS.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -3961,15 +4623,20 @@ }, { "name" : "is", + "type" : "function", "desc" : "Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child)", + "sig" : "(selector)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -3988,15 +4655,20 @@ }, { "name" : "move", + "type" : "function", "desc" : "Move this element relative to its current position.", + "sig" : "(direction, distance, animate)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "direction", @@ -4027,29 +4699,39 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Removes this element from the DOM and deletes it from the cache", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getNextSibling", + "type" : "function", "desc" : "Gets the next sibling, skipping text nodes", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -4061,15 +4743,20 @@ }, { "name" : "getStyle", + "type" : "function", "desc" : "Normalizes currentStyle and computedStyle. This is not YUI getStyle, it is an optimised version.", + "sig" : "(property)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "property", @@ -4088,15 +4775,20 @@ }, { "name" : "isBorderBox", + "type" : "function", "desc" : "Tests various css rules/browsers to determine if this element uses a border box", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -4108,15 +4800,20 @@ }, { "name" : "getPadding", + "type" : "function", "desc" : "Gets the width of the padding(s) for the specified side(s)", + "sig" : "(side)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "side", diff --git a/docs/symbols/Roo.EventManager.json b/docs/symbols/Roo.EventManager.json index 6bda683d2f..08edf768fb 100644 --- a/docs/symbols/Roo.EventManager.json +++ b/docs/symbols/Roo.EventManager.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "addListener", + "type" : "function", "desc" : "Appends an event handler to an element (shorthand for addListener)", + "sig" : "(element, eventName, handler, scope, options)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.EventManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "element", @@ -61,15 +68,20 @@ }, { "name" : "onDocumentReady", + "type" : "function", "desc" : "Fires when the document is ready (before onload and before images are loaded). Can be \naccessed shorthanded Roo.onReady().", + "sig" : "(fn, scope, options)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.EventManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -94,15 +106,20 @@ }, { "name" : "onTextResize", + "type" : "function", "desc" : "Fires when the user changes the active text size. Handler gets called with 2 params, the old size and the new size.", + "sig" : "(fn, scope, options)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.EventManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -127,15 +144,20 @@ }, { "name" : "on", + "type" : "function", "desc" : "Appends an event handler to an element (shorthand for addListener)", + "sig" : "(element, eventName, handler, scope, options)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.EventManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "element", @@ -172,15 +194,20 @@ }, { "name" : "removeResizeListener", + "type" : "function", "desc" : "Removes the passed window resize listener.", + "sig" : "(fn, scope)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.EventManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -199,15 +226,20 @@ }, { "name" : "onWindowResize", + "type" : "function", "desc" : "Fires when the window is resized and provides resize event buffering (50 milliseconds), passes new viewport width and height to handlers.", + "sig" : "(fn, scope, options)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.EventManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -232,15 +264,20 @@ }, { "name" : "wrap", + "type" : "function", "desc" : "This is no longer needed and is deprecated. Places a simple wrapper around an event handler to override the browser event\nobject with a Roo.EventObject", + "sig" : "(fn, scope, override)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.EventManager", "example" : "", "deprecated" : "This has been deprecated: ", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -271,15 +308,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes an event handler", + "sig" : "(element, eventName, fn)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.EventManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "element", diff --git a/docs/symbols/Roo.EventObject.json b/docs/symbols/Roo.EventObject.json index 9047577401..23ee2dc35c 100644 --- a/docs/symbols/Roo.EventObject.json +++ b/docs/symbols/Roo.EventObject.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "getPageX", + "type" : "function", "desc" : "Gets the x coordinate of the event.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.EventObject", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -36,15 +43,20 @@ }, { "name" : "getPageY", + "type" : "function", "desc" : "Gets the y coordinate of the event.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.EventObject", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -56,15 +68,20 @@ }, { "name" : "getTime", + "type" : "function", "desc" : "Gets the time of the event.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.EventObject", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -76,15 +93,20 @@ }, { "name" : "getXY", + "type" : "function", "desc" : "Gets the page coordinates of the event.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.EventObject", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -96,15 +118,20 @@ }, { "name" : "getRelatedTarget", + "type" : "function", "desc" : "Gets the related target.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.EventObject", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -116,15 +143,20 @@ }, { "name" : "getWheelDelta", + "type" : "function", "desc" : "Normalizes mouse wheel delta across browsers", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.EventObject", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -136,43 +168,58 @@ }, { "name" : "stopPropagation", + "type" : "function", "desc" : "Cancels bubbling of the event.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.EventObject", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "stopEvent", + "type" : "function", "desc" : "Stop the event (preventDefault and stopPropagation)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.EventObject", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "within", + "type" : "function", "desc" : "Returns true if the target of this event equals el or is a child of el", + "sig" : "(el, related)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.EventObject", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -197,15 +244,20 @@ }, { "name" : "hasModifier", + "type" : "function", "desc" : "Returns true if the control, meta, shift or alt key was pressed during this event.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.EventObject", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -217,15 +269,20 @@ }, { "name" : "getTarget", + "type" : "function", "desc" : "Gets the target for the event.", + "sig" : "(selector, maxDepth, returnEl)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.EventObject", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -256,29 +313,39 @@ }, { "name" : "preventDefault", + "type" : "function", "desc" : "Prevents the browsers default handling of the event.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.EventObject", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getCharCode", + "type" : "function", "desc" : "Gets the key code for the event.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.EventObject", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -290,15 +357,20 @@ }, { "name" : "getKey", + "type" : "function", "desc" : "Returns a normalized keyCode for the event.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.EventObject", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { diff --git a/docs/symbols/Roo.Fx.json b/docs/symbols/Roo.Fx.json index 0ef4c65494..15da66e8ee 100644 --- a/docs/symbols/Roo.Fx.json +++ b/docs/symbols/Roo.Fx.json @@ -12,97 +12,93 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "easing", "type" : "String", "desc" : "A valid Easing value for the effect", - "memberOf" : "Roo.Fx", - "optvals" : [] + "memberOf" : "" }, { "name" : "afterCls", "type" : "String", "desc" : "A css class to apply after the effect", - "memberOf" : "Roo.Fx", - "optvals" : [] + "memberOf" : "" }, { "name" : "useDisplay", "type" : "Boolean", "desc" : "Whether to use the display CSS property instead of visibility when hiding Elements (only applies to \neffects that end with the element being visually hidden, ignored otherwise)", - "memberOf" : "Roo.Fx", - "optvals" : [] + "memberOf" : "" }, { "name" : "stopFx", "type" : "Boolean", "desc" : "Whether subsequent effects should be stopped and removed after the current effect finishes", - "memberOf" : "Roo.Fx", - "optvals" : [] + "memberOf" : "" }, { "name" : "callback", "type" : "Function", "desc" : "A function called when the effect is finished", - "memberOf" : "Roo.Fx", - "optvals" : [] + "memberOf" : "" }, { "name" : "scope", "type" : "Object", "desc" : "The scope of the effect function", - "memberOf" : "Roo.Fx", - "optvals" : [] + "memberOf" : "" }, { "name" : "remove", "type" : "Boolean", "desc" : "Whether the Element should be removed from the DOM and destroyed after the effect finishes", - "memberOf" : "Roo.Fx", - "optvals" : [] + "memberOf" : "" }, { "name" : "concurrent", "type" : "Boolean", "desc" : "Whether to allow subsequently-queued effects to run at the same time as the current effect, or to ensure that they run in sequence", - "memberOf" : "Roo.Fx", - "optvals" : [] + "memberOf" : "" }, { "name" : "duration", "type" : "Number", "desc" : "The length of time (in seconds) that the effect should last", - "memberOf" : "Roo.Fx", - "optvals" : [] + "memberOf" : "" }, { "name" : "afterStyle", "type" : "String/Object/Function", "desc" : "A style specification string, e.g. \"width:100px\", or an object in the form {width:\"100px\"}, or\na function which returns such a specification that will be applied to the Element after the effect finishes", - "memberOf" : "Roo.Fx", - "optvals" : [] + "memberOf" : "" }, { "name" : "block", "type" : "Boolean", "desc" : "Whether the effect should block other effects from queueing while it runs", - "memberOf" : "Roo.Fx", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "fadeOut", + "type" : "function", "desc" : "Fade an element out (from opaque to transparent). The ending opacity can be specified\nusing the \"endOpacity\" config option.\nUsage:\n
\n// default: fade out from the element's current opacity to 0\nel.fadeOut();\n\n// custom: fade out from the element's current opacity to 25% over 2 seconds\nel.fadeOut({ endOpacity: .25, duration: 2});\n\n// common config options shown with default values\nel.fadeOut({\n    endOpacity: 0, //can be any value between 0 and 1 (e.g. .5)\n    easing: 'easeOut',\n    duration: .5\n    remove: false,\n    useDisplay: false\n});\n
", + "sig" : "(options)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Fx", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "options", @@ -121,15 +117,20 @@ }, { "name" : "stopFx", + "type" : "function", "desc" : "Stops any running effects and clears the element's internal effects queue if it contains\nany additional effects that haven't started yet.", + "sig" : "()\n{\n\n}", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Fx", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -141,15 +142,20 @@ }, { "name" : "frame", + "type" : "function", "desc" : "Shows a ripple of exploding, attenuating borders to draw attention to an Element.\nUsage:\n
\n// default: a single light blue ripple\nel.frame();\n\n// custom: 3 red ripples lasting 3 seconds total\nel.frame(\"ff0000\", 3, { duration: 3 });\n\n// common config options shown with default values\nel.frame(\"C3DAF9\", 1, {\n    duration: 1 //duration of entire animation (not each individual ripple)\n    // Note: Easing is not configurable and will be ignored if included\n});\n
", + "sig" : "(color, count, options)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Fx", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "color", @@ -180,15 +186,20 @@ }, { "name" : "pause", + "type" : "function", "desc" : "Creates a pause before any subsequent queued effects begin. If there are\nno effects queued after the pause it will have no effect.\nUsage:\n
\nel.pause(1);\n
", + "sig" : "(seconds)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Fx", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "seconds", @@ -207,15 +218,20 @@ }, { "name" : "hasFxBlock", + "type" : "function", "desc" : "Returns true if the element is currently blocking so that no other effect can be queued\nuntil this effect is finished, else returns false if blocking is not set. This is commonly\nused to ensure that an effect initiated by a user action runs to completion prior to the\nsame effect being restarted (e.g., firing only one effect even if the user clicks several times).", + "sig" : "()\n{\n\n}", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Fx", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -227,15 +243,20 @@ }, { "name" : "hasActiveFx", + "type" : "function", "desc" : "Returns true if the element has any effects actively running or queued, else returns false.", + "sig" : "()\n{\n\n}", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Fx", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -247,15 +268,20 @@ }, { "name" : "highlight", + "type" : "function", "desc" : "Highlights the Element by setting a color (applies to the background-color by default, but can be\nchanged using the \"attr\" config option) and then fading back to the original color. If no original\ncolor is available, you should provide the \"endColor\" config option which will be cleared after the animation.\nUsage:\n
\n// default: highlight background to yellow\nel.highlight();\n\n// custom: highlight foreground text to blue for 2 seconds\nel.highlight(\"0000ff\", { attr: 'color', duration: 2 });\n\n// common config options shown with default values\nel.highlight(\"ffff9c\", {\n    attr: \"background-color\", //can be any valid CSS property (attribute) that supports a color value\n    endColor: (current color) or \"ffffff\",\n    easing: 'easeIn',\n    duration: 1\n});\n
", + "sig" : "(color, options)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Fx", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "color", @@ -280,15 +306,20 @@ }, { "name" : "syncFx", + "type" : "function", "desc" : "Ensures that all effects queued after syncFx is called on the element are\nrun concurrently. This is the opposite of {@link #sequenceFx}.", + "sig" : "()\n{\n\n}", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Fx", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -300,15 +331,20 @@ }, { "name" : "puff", + "type" : "function", "desc" : "Fades the element out while slowly expanding it in all directions. When the effect is completed, the \nelement will be hidden (visibility = 'hidden') but block elements will still take up space in the document. \nThe element must be removed from the DOM using the 'remove' config option if desired.\nUsage:\n
\n// default\nel.puff();\n\n// common config options shown with default values\nel.puff({\n    easing: 'easeOut',\n    duration: .5,\n    remove: false,\n    useDisplay: false\n});\n
", + "sig" : "(options)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Fx", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "options", @@ -327,15 +363,20 @@ }, { "name" : "fadeIn", + "type" : "function", "desc" : "Fade an element in (from transparent to opaque). The ending opacity can be specified\nusing the \"endOpacity\" config option.\nUsage:\n
\n// default: fade in from opacity 0 to 100%\nel.fadeIn();\n\n// custom: fade in from opacity 0 to 75% over 2 seconds\nel.fadeIn({ endOpacity: .75, duration: 2});\n\n// common config options shown with default values\nel.fadeIn({\n    endOpacity: 1, //can be any value between 0 and 1 (e.g. .5)\n    easing: 'easeOut',\n    duration: .5\n});\n
", + "sig" : "(options)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Fx", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "options", @@ -354,15 +395,20 @@ }, { "name" : "sequenceFx", + "type" : "function", "desc" : "Ensures that all effects queued after sequenceFx is called on the element are\nrun in sequence. This is the opposite of {@link #syncFx}.", + "sig" : "()\n{\n\n}", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Fx", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -374,15 +420,20 @@ }, { "name" : "slideIn", + "type" : "function", "desc" : "Slides the element into view. An anchor point can be optionally passed to set the point of\norigin for the slide effect. This function automatically handles wrapping the element with\na fixed-size container if needed. See the Fx class overview for valid anchor point options.\nUsage:\n
\n// default: slide the element in from the top\nel.slideIn();\n\n// custom: slide the element in from the right with a 2-second duration\nel.slideIn('r', { duration: 2 });\n\n// common config options shown with default values\nel.slideIn('t', {\n    easing: 'easeOut',\n    duration: .5\n});\n
", + "sig" : "(anchor, options)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Fx", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "anchor", @@ -407,15 +458,20 @@ }, { "name" : "ghost", + "type" : "function", "desc" : "Slides the element while fading it out of view. An anchor point can be optionally passed to set the \nending point of the effect.\nUsage:\n
\n// default: slide the element downward while fading out\nel.ghost();\n\n// custom: slide the element out to the right with a 2-second duration\nel.ghost('r', { duration: 2 });\n\n// common config options shown with default values\nel.ghost('b', {\n    easing: 'easeOut',\n    duration: .5\n    remove: false,\n    useDisplay: false\n});\n
", + "sig" : "(anchor, options)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Fx", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "anchor", @@ -440,15 +496,20 @@ }, { "name" : "slideOut", + "type" : "function", "desc" : "Slides the element out of view. An anchor point can be optionally passed to set the end point\nfor the slide effect. When the effect is completed, the element will be hidden (visibility = \n'hidden') but block elements will still take up space in the document. The element must be removed\nfrom the DOM using the 'remove' config option if desired. This function automatically handles \nwrapping the element with a fixed-size container if needed. See the Fx class overview for valid anchor point options.\nUsage:\n
\n// default: slide the element out to the top\nel.slideOut();\n\n// custom: slide the element out to the right with a 2-second duration\nel.slideOut('r', { duration: 2 });\n\n// common config options shown with default values\nel.slideOut('t', {\n    easing: 'easeOut',\n    duration: .5,\n    remove: false,\n    useDisplay: false\n});\n
", + "sig" : "(anchor, options)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Fx", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "anchor", @@ -473,15 +534,20 @@ }, { "name" : "scale", + "type" : "function", "desc" : "Animates the transition of an element's dimensions from a starting height/width\nto an ending height/width.\nUsage:\n
\n// change height and width to 100x100 pixels\nel.scale(100, 100);\n\n// common config options shown with default values.  The height and width will default to\n// the element's existing values if passed as null.\nel.scale(\n    [element's width],\n    [element's height], {\n    easing: 'easeOut',\n    duration: .35\n});\n
", + "sig" : "(width, height, options)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Fx", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -512,15 +578,20 @@ }, { "name" : "switchOff", + "type" : "function", "desc" : "Blinks the element as if it was clicked and then collapses on its center (similar to switching off a television).\nWhen the effect is completed, the element will be hidden (visibility = 'hidden') but block elements will still \ntake up space in the document. The element must be removed from the DOM using the 'remove' config option if desired.\nUsage:\n
\n// default\nel.switchOff();\n\n// all config options shown with default values\nel.switchOff({\n    easing: 'easeIn',\n    duration: .3,\n    remove: false,\n    useDisplay: false\n});\n
", + "sig" : "(options)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Fx", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "options", @@ -539,15 +610,20 @@ }, { "name" : "shift", + "type" : "function", "desc" : "Animates the transition of any combination of an element's dimensions, xy position and/or opacity.\nAny of these properties not specified in the config object will not be changed. This effect \nrequires that at least one new dimension, position or opacity setting must be passed in on\nthe config object in order for the function to have any effect.\nUsage:\n
\n// slide the element horizontally to x position 200 while changing the height and opacity\nel.shift({ x: 200, height: 50, opacity: .8 });\n\n// common config options shown with default values.\nel.shift({\n    width: [element's width],\n    height: [element's height],\n    x: [element's x position],\n    y: [element's y position],\n    opacity: [element's opacity],\n    easing: 'easeOut',\n    duration: .35\n});\n
", + "sig" : "(options)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Fx", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "options", diff --git a/docs/symbols/Roo.GridPanel.json b/docs/symbols/Roo.GridPanel.json index e09cac8994..12ee86c170 100644 --- a/docs/symbols/Roo.GridPanel.json +++ b/docs/symbols/Roo.GridPanel.json @@ -28,145 +28,135 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "loadOnce", "type" : "Boolean", "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "autoScroll", "type" : "Boolean", "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "fitToFrame", "type" : "Boolean", "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "background", "type" : "Boolean", "desc" : "True if the panel should not be activated when it is added (defaults to false)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "toolbar", - "type" : "Toolbar", + "type" : "Roo.Toolbar", "desc" : "A toolbar for this panel", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "region", "type" : "String", - "desc" : "t) which region to put this panel on (when used with xtype constructors)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [ - "center", - "north", - "south", - "east", - "west" - ] + "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)", + "memberOf" : "Roo.ContentPanel" }, { "name" : "content", "type" : "String", "desc" : "Raw content to fill content panel with (uses setContent on construction.)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "menu", + "type" : "Roo.menu.Menu", + "desc" : "popup menu", + "memberOf" : "Roo.ContentPanel" }, { "name" : "title", "type" : "String", "desc" : "The title for this panel", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "style", "type" : "String", "desc" : "Extra style to add to the content panel", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "autoCreate", - "type" : "Boolean/Object", + "type" : "Boolean|Object", "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "fitContainer", "type" : "Boolean", "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "closable", "type" : "Boolean", "desc" : "True if the panel can be closed/removed", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "params", - "type" : "String/Object", + "type" : "String|Object", "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "adjustments", "type" : "Array", "desc" : "Values to add to the width/height when doing a {@link #fitToFrame} (default is [0, 0])", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "url", "type" : "String", "desc" : "Calls {@link #setUrl} with this value", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "resizeEl", - "type" : "String/HTMLElement/Element", + "type" : "String|HTMLElement|Element", "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" } ], "methods" : [ { "name" : "getGrid", + "type" : "function", "desc" : "Returns the grid for this panel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.GridPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -178,15 +168,20 @@ }, { "name" : "load", + "type" : "function", "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.", + "sig" : "(url, params, callback, discardUrl)", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "url", @@ -223,15 +218,20 @@ }, { "name" : "getUpdateManager", + "type" : "function", "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -243,15 +243,20 @@ }, { "name" : "isClosable", + "type" : "function", "desc" : "Returns true is this panel was configured to be closable", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -263,29 +268,39 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Destroys this panel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getEl", + "type" : "function", "desc" : "Returns this panel's element - used by regiosn to add.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -297,15 +312,20 @@ }, { "name" : "setContent", + "type" : "function", "desc" : "Updates this panel's element", + "sig" : "(content, loadScripts)", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "content", @@ -324,15 +344,20 @@ }, { "name" : "getId", + "type" : "function", "desc" : "Returns this panel's id", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -344,15 +369,20 @@ }, { "name" : "addxtype", + "type" : "function", "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n
\n\nlayout.addxtype({\n       xtype : 'Form',\n       items: [ .... ]\n   }\n);\n\n
", + "sig" : "(cfg)", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cfg", @@ -365,29 +395,39 @@ }, { "name" : "refresh", + "type" : "function", "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getTitle", + "type" : "function", "desc" : "Returns this panel's title", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -399,15 +439,20 @@ }, { "name" : "setTitle", + "type" : "function", "desc" : "Set this panel's title", + "sig" : "(title)", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "title", @@ -420,15 +465,20 @@ }, { "name" : "getToolbar", + "type" : "function", "desc" : "Returns the toolbar for this Panel if one was configured.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -440,15 +490,20 @@ }, { "name" : "setUrl", + "type" : "function", "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.", + "sig" : "(url, params, loadOnce)", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "url", @@ -479,29 +534,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -532,15 +597,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -565,15 +635,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -586,15 +661,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -607,15 +687,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -640,15 +725,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -673,15 +763,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -700,15 +795,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -733,15 +833,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -774,7 +879,9 @@ "events" : [ { "name" : "deactivate", + "type" : "function", "desc" : "Fires when this panel is activated.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", @@ -792,7 +899,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires when this panel is resized if fitToFrame is true.", + "sig" : "function (_self, width, height)\n{\n\n}", "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", @@ -822,7 +931,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires when this tab is created", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", @@ -840,7 +951,9 @@ }, { "name" : "activate", + "type" : "function", "desc" : "Fires when this panel is activated.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.HtmlEditorCore.json b/docs/symbols/Roo.HtmlEditorCore.json index d2d1d91549..c19f3f84ef 100644 --- a/docs/symbols/Roo.HtmlEditorCore.json +++ b/docs/symbols/Roo.HtmlEditorCore.json @@ -15,100 +15,93 @@ "see" : "", "params" : [], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "allowComments", "type" : "boolean", "desc" : "- default false - allow comments in HTML source - by default they are stripped - if you are editing email you may need this.", - "memberOf" : "Roo.HtmlEditorCore", - "optvals" : [] + "memberOf" : "" }, { "name" : "the", "type" : "Roo.form.HtmlEditor|Roo.bootstrap.HtmlEditor", "desc" : "owner field", - "memberOf" : "Roo.HtmlEditorCore", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "width", "type" : "Number", "desc" : "(in pixels)", - "memberOf" : "Roo.HtmlEditorCore", - "optvals" : [] + "memberOf" : "" }, { "name" : "resizable", "type" : "String", "desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.", - "memberOf" : "Roo.HtmlEditorCore", - "optvals" : [] + "memberOf" : "" }, { "name" : "height", "type" : "Number", "desc" : "(in pixels)", - "memberOf" : "Roo.HtmlEditorCore", - "optvals" : [] + "memberOf" : "" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "stylesheets", "type" : "Array", "desc" : "url of stylesheets. set to [] to disable stylesheets.", - "memberOf" : "Roo.HtmlEditorCore", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "relayCmd", + "type" : "function", "desc" : "Executes a Midas editor command on the editor document and performs necessary focus and\ntoolbar updates. This should only be called after the editor is initialized.", + "sig" : "(cmd, value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.HtmlEditorCore", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cmd", @@ -127,15 +120,20 @@ }, { "name" : "execCmd", + "type" : "function", "desc" : "Executes a Midas editor command directly on the editor document.\nFor visual commands, you should use {@link #relayCmd} instead.\nThis should only be called after the editor is initialized.", + "sig" : "(cmd, value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.HtmlEditorCore", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cmd", @@ -154,57 +152,77 @@ }, { "name" : "cleanWord", + "type" : "function", "desc" : "Clean up MS wordisms...", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.HtmlEditorCore", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "syncValue", + "type" : "function", "desc" : "HTML Editor -> Textarea\nProtected method that will not generally be called directly. Syncs the contents\nof the editor iframe with the textarea.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.HtmlEditorCore", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "cleanTableWidths", + "type" : "function", "desc" : "cleanTableWidths.\n\nQuite often pasting from word etc.. results in tables with column and widths.\nThis does not work well on fluid HTML layouts - like emails. - so this code should hunt an destroy them..", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.HtmlEditorCore", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "cleanHtml", + "type" : "function", "desc" : "Protected method that will not generally be called directly. If you need/want\ncustom HTML cleanup, this is the method you should override.", + "sig" : "(html)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.HtmlEditorCore", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "html", @@ -217,15 +235,20 @@ }, { "name" : "toggleSourceEdit", + "type" : "function", "desc" : "Toggles the editor between standard and source edit mode.", + "sig" : "(sourceEdit)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.HtmlEditorCore", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sourceEdit", @@ -238,29 +261,39 @@ }, { "name" : "getDocMarkup", + "type" : "function", "desc" : "Protected method that will not generally be called directly. It\nis called when the editor initializes the iframe with HTML contents. Override this method if you\nwant to change the initialization markup of the iframe (e.g. to add stylesheets).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.HtmlEditorCore", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "iterateChildren", + "type" : "function", "desc" : "iterateChildren of a Node, calling fn each time, using this as the scole..", + "sig" : "(node, fn)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.HtmlEditorCore", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -279,43 +312,58 @@ }, { "name" : "pushValue", + "type" : "function", "desc" : "Protected method that will not generally be called directly. Pushes the value of the textarea\ninto the iframe editor.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.HtmlEditorCore", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "rangeIntersectsNode", + "type" : "function", "desc" : "Range intersection.. the hard stuff...\n '-1' = before\n '0' = hits..\n '1' = after.\n [ -- selected range --- ]\n [fail] [fail]\n\n basically..\n if end is before start or hits it. fail.\n if start is after end or hits it fail.\n\n if either hits (but other is outside. - then it's not", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.HtmlEditorCore", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "insertAtCursor", + "type" : "function", "desc" : "Inserts the passed text at the current cursor position. Note: the editor must be initialized and activated\nto insert tRoo.", + "sig" : "(text)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.HtmlEditorCore", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "text", @@ -328,15 +376,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -348,15 +401,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -369,43 +427,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -418,15 +491,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -438,15 +516,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -465,15 +548,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -485,15 +573,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -505,15 +598,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -532,15 +630,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -552,15 +655,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -572,29 +680,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -625,15 +743,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -658,15 +781,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -679,15 +807,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -700,15 +833,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -733,15 +871,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -766,15 +909,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -793,15 +941,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -826,15 +979,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -867,8 +1025,10 @@ "events" : [ { "name" : "specialkey", + "type" : "function", "desc" : "", - "memberOf" : "Roo.HtmlEditorCore", + "sig" : "function ()\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -878,8 +1038,10 @@ }, { "name" : "editorevent", + "type" : "function", "desc" : "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.", - "memberOf" : "Roo.HtmlEditorCore", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -896,8 +1058,10 @@ }, { "name" : "beforepush", + "type" : "function", "desc" : "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push.", - "memberOf" : "Roo.HtmlEditorCore", + "sig" : "function (_self, html)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -920,8 +1084,10 @@ }, { "name" : "activate", + "type" : "function", "desc" : "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event.", - "memberOf" : "Roo.HtmlEditorCore", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -938,8 +1104,10 @@ }, { "name" : "initialize", + "type" : "function", "desc" : "Fires when the editor is fully initialized (including the iframe)", - "memberOf" : "Roo.HtmlEditorCore", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -956,8 +1124,10 @@ }, { "name" : "beforesync", + "type" : "function", "desc" : "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync.", - "memberOf" : "Roo.HtmlEditorCore", + "sig" : "function (_self, html)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -980,8 +1150,10 @@ }, { "name" : "push", + "type" : "function", "desc" : "Fires when the iframe editor is updated with content from the textarea.", - "memberOf" : "Roo.HtmlEditorCore", + "sig" : "function (_self, html)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1004,8 +1176,10 @@ }, { "name" : "sync", + "type" : "function", "desc" : "Fires when the textarea is updated with content from the editor iframe.", - "memberOf" : "Roo.HtmlEditorCore", + "sig" : "function (_self, html)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1028,8 +1202,10 @@ }, { "name" : "change", + "type" : "function", "desc" : "", - "memberOf" : "Roo.HtmlEditorCore", + "sig" : "function ()\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1039,8 +1215,10 @@ }, { "name" : "blur", + "type" : "function", "desc" : "", - "memberOf" : "Roo.HtmlEditorCore", + "sig" : "function ()\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1050,8 +1228,10 @@ }, { "name" : "focus", + "type" : "function", "desc" : "", - "memberOf" : "Roo.HtmlEditorCore", + "sig" : "function ()\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1061,7 +1241,9 @@ }, { "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" : "", @@ -1079,7 +1261,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1097,7 +1281,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1115,7 +1301,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1133,7 +1321,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1151,7 +1341,9 @@ }, { "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" : "", @@ -1169,7 +1361,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1187,7 +1381,9 @@ }, { "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" : "", @@ -1205,7 +1401,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1223,7 +1421,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.JsonView.json b/docs/symbols/Roo.JsonView.json index 99c148cd1a..384f5e8088 100644 --- a/docs/symbols/Roo.JsonView.json +++ b/docs/symbols/Roo.JsonView.json @@ -22,104 +22,99 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "selectedClass", "type" : "String", "desc" : "The css class to add to selected nodes", - "memberOf" : "Roo.View", - "optvals" : [] + "memberOf" : "Roo.View" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "dataName", "type" : "String", "desc" : "the named area of the template to use as the data area\n Works with domtemplates roo-name=\"name\"", - "memberOf" : "Roo.View", - "optvals" : [] + "memberOf" : "Roo.View" }, { "name" : "text", "type" : "String", "desc" : "to display on mask (default Loading)", - "memberOf" : "Roo.View", - "optvals" : [] + "memberOf" : "Roo.View" }, { "name" : "multiSelect", "type" : "Boolean", "desc" : "Allow multiple selection", - "memberOf" : "Roo.View", - "optvals" : [] + "memberOf" : "Roo.View" }, { "name" : "emptyText", "type" : "String", "desc" : "The empty text to show when nothing is loaded.", - "memberOf" : "Roo.View", - "optvals" : [] + "memberOf" : "Roo.View" }, { "name" : "store", "type" : "Roo.data.Store", "desc" : "Data store to load data from.", - "memberOf" : "Roo.View", - "optvals" : [] + "memberOf" : "Roo.View" }, { "name" : "toggleSelect", "type" : "Boolean", "desc" : "- selecting", - "memberOf" : "Roo.View", - "optvals" : [] + "memberOf" : "Roo.View" }, { "name" : "singleSelect", "type" : "Boolean", "desc" : "Allow single selection", - "memberOf" : "Roo.View", - "optvals" : [] + "memberOf" : "Roo.View" }, { "name" : "tickable", "type" : "Boolean", "desc" : "- selecting", - "memberOf" : "Roo.View", - "optvals" : [] + "memberOf" : "Roo.View" }, { "name" : "el", "type" : "String|Roo.Element", "desc" : "The container element.", - "memberOf" : "Roo.View", - "optvals" : [] + "memberOf" : "Roo.View" }, { "name" : "tpl", "type" : "String|Roo.Template", "desc" : "The template used by this View", - "memberOf" : "Roo.View", - "optvals" : [] + "memberOf" : "Roo.View" } ], "methods" : [ { "name" : "getNodeData", + "type" : "function", "desc" : "Returns the JSON object for the specified node(s)", + "sig" : "(node)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.JsonView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -138,15 +133,20 @@ }, { "name" : "getCount", + "type" : "function", "desc" : "Get the number of records in the current JSON dataset", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.JsonView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -158,15 +158,20 @@ }, { "name" : "sort", + "type" : "function", "desc" : "Sorts the data for this view and refreshes it.", + "sig" : "(property, direction, sortType)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.JsonView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "property", @@ -191,29 +196,39 @@ }, { "name" : "refresh", + "type" : "function", "desc" : "Refreshes the view.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.JsonView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "filterBy", + "type" : "function", "desc" : "Filter by a function. The passed function will be called with each\nobject in the current dataset. If the function returns true the value is kept,\notherwise it is filtered.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.JsonView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -232,29 +247,39 @@ }, { "name" : "clearFilter", + "type" : "function", "desc" : "Clears the current filter.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.JsonView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "load", + "type" : "function", "desc" : "Performs an async HTTP request, and loads the JSON from the response. If params are specified it uses POST, otherwise it uses GET.", + "sig" : "(url, params, callback, discardUrl)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.JsonView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "url", @@ -285,15 +310,20 @@ }, { "name" : "filter", + "type" : "function", "desc" : "Filter the data by a specific property.", + "sig" : "(property, value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.JsonView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "property", @@ -312,15 +342,20 @@ }, { "name" : "getSelectedNodes", + "type" : "function", "desc" : "Get the currently selected nodes.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.View", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -332,15 +367,20 @@ }, { "name" : "getNodes", + "type" : "function", "desc" : "Gets a range template nodes.", + "sig" : "(startIndex, endIndex)", + "static" : false, + "memberOf" : "Roo.View", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "startIndex", @@ -365,15 +405,20 @@ }, { "name" : "select", + "type" : "function", "desc" : "Selects nodes.", + "sig" : "(nodeInfo, keepExisting, suppressEvent)", + "static" : false, + "memberOf" : "Roo.View", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "nodeInfo", @@ -398,15 +443,20 @@ }, { "name" : "clearSelections", + "type" : "function", "desc" : "Clear all selections", + "sig" : "(suppressEvent)", + "static" : false, + "memberOf" : "Roo.View", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "suppressEvent", @@ -419,15 +469,20 @@ }, { "name" : "isSelected", + "type" : "function", "desc" : "Returns true if the passed node is selected", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.View", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -446,29 +501,39 @@ }, { "name" : "onBeforeLoad", + "type" : "function", "desc" : "onbeforeLoad - masks the loading area.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.View", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getSelectedIndexes", + "type" : "function", "desc" : "Get the indexes of the selected nodes.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.View", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -480,15 +545,20 @@ }, { "name" : "indexOf", + "type" : "function", "desc" : "Finds the index of the passed node", + "sig" : "(nodeInfo)", + "static" : false, + "memberOf" : "Roo.View", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "nodeInfo", @@ -507,15 +577,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the element this view is bound to.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.View", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -527,15 +602,20 @@ }, { "name" : "setStore", + "type" : "function", "desc" : "Changes the data store this view uses and refresh the view.", + "sig" : "(store)", + "static" : false, + "memberOf" : "Roo.View", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "store", @@ -548,15 +628,20 @@ }, { "name" : "refreshNode", + "type" : "function", "desc" : "Refresh an individual node.", + "sig" : "(index)", + "static" : false, + "memberOf" : "Roo.View", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -569,15 +654,20 @@ }, { "name" : "prepareData", + "type" : "function", "desc" : "Function to override to reformat the data that is sent to\nthe template for each node.\nDEPRICATED - use the preparedata event handler.", + "sig" : "(data)", + "static" : false, + "memberOf" : "Roo.View", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "data", @@ -590,15 +680,20 @@ }, { "name" : "getSelectionCount", + "type" : "function", "desc" : "Get the number of selected nodes.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.View", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -610,15 +705,20 @@ }, { "name" : "findItemFromChild", + "type" : "function", "desc" : "Returns the template node the passed child belongs to or null if it doesn't belong to one.", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.View", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -637,15 +737,20 @@ }, { "name" : "unselect", + "type" : "function", "desc" : "Unselects nodes.", + "sig" : "(nodeInfo, keepExisting, suppressEvent)", + "static" : false, + "memberOf" : "Roo.View", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "nodeInfo", @@ -670,15 +775,20 @@ }, { "name" : "getNode", + "type" : "function", "desc" : "Gets a template node.", + "sig" : "(nodeInfo)", + "static" : false, + "memberOf" : "Roo.View", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "nodeInfo", @@ -697,29 +807,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -750,15 +870,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -783,15 +908,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -804,15 +934,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -825,15 +960,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -858,15 +998,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -891,15 +1036,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -918,15 +1068,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -951,15 +1106,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -992,8 +1152,10 @@ "events" : [ { "name" : "loadexception", + "type" : "function", "desc" : "Fires when loading fails.", - "memberOf" : "Roo.JsonView", + "sig" : "function (_self, response)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1016,8 +1178,10 @@ }, { "name" : "load", + "type" : "function", "desc" : "Fires when data is loaded.", - "memberOf" : "Roo.JsonView", + "sig" : "function (_self, data, response)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1046,8 +1210,10 @@ }, { "name" : "beforerender", + "type" : "function", "desc" : "Fires before rendering of the downloaded JSON data.", - "memberOf" : "Roo.JsonView", + "sig" : "function (_self, data)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1070,7 +1236,9 @@ }, { "name" : "dblclick", + "type" : "function", "desc" : "Fires when a template node is double clicked.", + "sig" : "function (_self, index, node, e)\n{\n\n}", "memberOf" : "Roo.View", "example" : "", "deprecated" : "", @@ -1106,7 +1274,9 @@ }, { "name" : "preparedata", + "type" : "function", "desc" : "Fires on every row to render, to allow you to change the data.", + "sig" : "function (_self, data)\n{\n\n}", "memberOf" : "Roo.View", "example" : "", "deprecated" : "", @@ -1130,7 +1300,9 @@ }, { "name" : "selectionchange", + "type" : "function", "desc" : "Fires when the selected nodes change.", + "sig" : "function (_self, selections)\n{\n\n}", "memberOf" : "Roo.View", "example" : "", "deprecated" : "", @@ -1154,7 +1326,9 @@ }, { "name" : "beforeselect", + "type" : "function", "desc" : "Fires before a selection is made. If any handlers return false, the selection is cancelled.", + "sig" : "function (_self, node, selections)\n{\n\n}", "memberOf" : "Roo.View", "example" : "", "deprecated" : "", @@ -1184,7 +1358,9 @@ }, { "name" : "beforeclick", + "type" : "function", "desc" : "Fires before a click is processed. Returns false to cancel the default action.", + "sig" : "function (_self, index, node, e)\n{\n\n}", "memberOf" : "Roo.View", "example" : "", "deprecated" : "", @@ -1220,7 +1396,9 @@ }, { "name" : "click", + "type" : "function", "desc" : "Fires when a template node is clicked.", + "sig" : "function (_self, index, node, e)\n{\n\n}", "memberOf" : "Roo.View", "example" : "", "deprecated" : "", @@ -1256,7 +1434,9 @@ }, { "name" : "contextmenu", + "type" : "function", "desc" : "Fires when a template node is right clicked.", + "sig" : "function (_self, index, node, e)\n{\n\n}", "memberOf" : "Roo.View", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.KeyMap.json b/docs/symbols/Roo.KeyMap.json index ffb65a07ad..7e40c528ae 100644 --- a/docs/symbols/Roo.KeyMap.json +++ b/docs/symbols/Roo.KeyMap.json @@ -31,19 +31,26 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "on", + "type" : "function", "desc" : "Shorthand for adding a single key listener", + "sig" : "(key, fn, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.KeyMap", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "key", @@ -68,29 +75,39 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this KeyMap", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.KeyMap", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isEnabled", + "type" : "function", "desc" : "Returns true if this KeyMap is enabled", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.KeyMap", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -102,29 +119,39 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enables this KeyMap", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.KeyMap", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "addBinding", + "type" : "function", "desc" : "Add a new binding to this KeyMap. The following config object properties are supported:\n
\nProperty    Type             Description\n----------  ---------------  ----------------------------------------------------------------------\nkey         String/Array     A single keycode or an array of keycodes to handle\nshift       Boolean          True to handle key only when shift is pressed (defaults to false)\nctrl        Boolean          True to handle key only when ctrl is pressed (defaults to false)\nalt         Boolean          True to handle key only when alt is pressed (defaults to false)\nfn          Function         The function to call when KeyMap finds the expected key combination\nscope       Object           The scope of the callback function\n
\n\nUsage:\n
\n// Create a KeyMap\nvar map = new Roo.KeyMap(document, {\n    key: Roo.EventObject.ENTER,\n    fn: handleKey,\n    scope: this\n});\n\n//Add a new binding to the existing KeyMap later\nmap.addBinding({\n    key: 'abc',\n    shift: true,\n    fn: handleKey,\n    scope: this\n});\n
", + "sig" : "(config)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.KeyMap", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", diff --git a/docs/symbols/Roo.KeyNav.json b/docs/symbols/Roo.KeyNav.json index 342292e063..968006e112 100644 --- a/docs/symbols/Roo.KeyNav.json +++ b/docs/symbols/Roo.KeyNav.json @@ -25,55 +25,64 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "disabled", "type" : "Boolean", "desc" : "True to disable this KeyNav instance (defaults to false)", - "memberOf" : "Roo.KeyNav", - "optvals" : [] + "memberOf" : "" }, { "name" : "defaultEventAction", "type" : "String", "desc" : "The method to call on the {@link Roo.EventObject} after this KeyNav intercepts a key. Valid values are\n{@link Roo.EventObject#stopEvent}, {@link Roo.EventObject#preventDefault} and\n{@link Roo.EventObject#stopPropagation} (defaults to 'stopEvent')", - "memberOf" : "Roo.KeyNav", - "optvals" : [] + "memberOf" : "" }, { "name" : "forceKeyDown", "type" : "Boolean", "desc" : "Handle the keydown event instead of keypress (defaults to false). KeyNav automatically does this for IE since\nIE does not propagate special keys on keypress, but setting this to true will force other browsers to also\nhandle keydown instead of keypress.", - "memberOf" : "Roo.KeyNav", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "enable", + "type" : "function", "desc" : "Enable this KeyNav", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.KeyNav", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "disable", + "type" : "function", "desc" : "Disable this KeyNav", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.KeyNav", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] } diff --git a/docs/symbols/Roo.Layer.json b/docs/symbols/Roo.Layer.json index 9cc23def62..d1a276767a 100644 --- a/docs/symbols/Roo.Layer.json +++ b/docs/symbols/Roo.Layer.json @@ -27,69 +27,69 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "shadow", "type" : "String/Boolean", "desc" : "True to create a shadow element with default class \"x-layer-shadow\", or\nyou can pass a string with a CSS class name. False turns off the shadow.", - "memberOf" : "Roo.Layer", - "optvals" : [] + "memberOf" : "" }, { "name" : "constrain", "type" : "Boolean", "desc" : "False to disable constrain to viewport (defaults to true)", - "memberOf" : "Roo.Layer", - "optvals" : [] + "memberOf" : "" }, { "name" : "zindex", "type" : "Number", "desc" : "Starting z-index (defaults to 11000)", - "memberOf" : "Roo.Layer", - "optvals" : [] + "memberOf" : "" }, { "name" : "shadowOffset", "type" : "Number", "desc" : "Number of pixels to offset the shadow (defaults to 3)", - "memberOf" : "Roo.Layer", - "optvals" : [] + "memberOf" : "" }, { "name" : "dh", "type" : "Object", "desc" : "DomHelper object config to create element with (defaults to {tag: \"div\", cls: \"x-layer\"}).", - "memberOf" : "Roo.Layer", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "CSS class to add to the element", - "memberOf" : "Roo.Layer", - "optvals" : [] + "memberOf" : "" }, { "name" : "shim", "type" : "Boolean", "desc" : "False to disable the iframe shim in browsers which need one (defaults to true)", - "memberOf" : "Roo.Layer", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "setZIndex", + "type" : "function", "desc" : "Sets the z-index of this layer and adjusts any shadow and shim z-indexes. The layer z-index is automatically\nincremented by two more than the value passed in so that it always shows above any shadow or shim (the shadow\nelement, if any, will be assigned z-index + 1, and the shim element, if any, will be assigned the unmodified z-index).", + "sig" : "(zindex)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Layer", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "zindex", @@ -108,15 +108,20 @@ }, { "name" : "getCenterXY", + "type" : "function", "desc" : "Calculates the x, y to center this element on the screen", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -128,15 +133,20 @@ }, { "name" : "getScroll", + "type" : "function", "desc" : "Returns the current scroll position of the element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -148,15 +158,20 @@ }, { "name" : "createShim", + "type" : "function", "desc" : "Creates an iframe shim for this element to keep selects and other windowed objects from\nshowing through.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -168,15 +183,20 @@ }, { "name" : "scrollTo", + "type" : "function", "desc" : "Scrolls this element the specified scroll point. It does NOT do bounds checking so if you scroll to a weird value it will try to do it. For auto bounds checking, use scroll().", + "sig" : "(side, value, animate)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "side", @@ -207,15 +227,20 @@ }, { "name" : "removeAllListeners", + "type" : "function", "desc" : "Removes all previous added listeners from this element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -227,15 +252,20 @@ }, { "name" : "setStyle", + "type" : "function", "desc" : "Wrapper for setting style properties, also takes single object parameter of multiple styles.", + "sig" : "(property, value)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "property", @@ -260,15 +290,20 @@ }, { "name" : "on", + "type" : "function", "desc" : "Appends an event handler (Shorthand for addListener)", + "sig" : "(eventName, fn, scope, options)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -299,15 +334,20 @@ }, { "name" : "addClassOnClick", + "type" : "function", "desc" : "Sets up event handlers to add and remove a css class when the mouse is down and then up on this element (a click effect)", + "sig" : "(className)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "className", @@ -326,15 +366,20 @@ }, { "name" : "getBorderWidth", + "type" : "function", "desc" : "Gets the width of the border(s) for the specified side(s)", + "sig" : "(side)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "side", @@ -353,15 +398,20 @@ }, { "name" : "scroll", + "type" : "function", "desc" : "Scrolls this element the specified direction. Does bounds checking to make sure the scroll is\nwithin this element's scrollable range.", + "sig" : "(direction, distance, animate)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "direction", @@ -392,15 +442,20 @@ }, { "name" : "addKeyMap", + "type" : "function", "desc" : "Creates a KeyMap for this element", + "sig" : "(config)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -419,15 +474,20 @@ }, { "name" : "createChild", + "type" : "function", "desc" : "Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element.", + "sig" : "(config, insertBefore, returnDom)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -458,15 +518,20 @@ }, { "name" : "addClass", + "type" : "function", "desc" : "Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.", + "sig" : "(className)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "className", @@ -485,15 +550,20 @@ }, { "name" : "attr", + "type" : "function", "desc" : "Sets or Returns the value the dom attribute value", + "sig" : "(name, value)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "name", @@ -518,15 +588,20 @@ }, { "name" : "setOpacity", + "type" : "function", "desc" : "Set the opacity of the element", + "sig" : "(opacity, animate)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "opacity", @@ -551,15 +626,20 @@ }, { "name" : "setSize", + "type" : "function", "desc" : "Set the size of the element. If animation is true, both width an height will be animated concurrently.", + "sig" : "(width, height, animate)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -590,15 +670,20 @@ }, { "name" : "un", + "type" : "function", "desc" : "Removes an event handler from this element (shorthand for removeListener)", + "sig" : "(eventName, fn)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -623,15 +708,20 @@ }, { "name" : "up", + "type" : "function", "desc" : "Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first-child).\nThis is a shortcut for findParentNode() that always returns an Roo.Element.", + "sig" : "(selector, maxDepth)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -656,15 +746,20 @@ }, { "name" : "repaint", + "type" : "function", "desc" : "Forces the browser to repaint this element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -676,15 +771,20 @@ }, { "name" : "translatePoints", + "type" : "function", "desc" : "Translates the passed page coordinates into left/top css values for this element", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -709,15 +809,20 @@ }, { "name" : "createProxy", + "type" : "function", "desc" : "Creates a proxy element of this element", + "sig" : "(config, renderTo, matchBox)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -748,15 +853,20 @@ }, { "name" : "down", + "type" : "function", "desc" : "Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id).", + "sig" : "(selector, returnDom)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -781,15 +891,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Return a box {x, y, width, height} that can be used to set another elements\nsize/location to match this element.", + "sig" : "(contentBox, local)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "contentBox", @@ -814,15 +929,20 @@ }, { "name" : "toggle", + "type" : "function", "desc" : "Toggles the element's visibility or display, depending on visibility mode.", + "sig" : "(animate)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "animate", @@ -841,15 +961,20 @@ }, { "name" : "setBounds", + "type" : "function", "desc" : "Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated concurrently.", + "sig" : "(x, y, width, height, animate)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -892,15 +1017,20 @@ }, { "name" : "getX", + "type" : "function", "desc" : "Gets the current X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -912,15 +1042,20 @@ }, { "name" : "getY", + "type" : "function", "desc" : "Gets the current Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -932,15 +1067,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Tries to focus the element. Any exceptions are caught and ignored.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -952,15 +1092,20 @@ }, { "name" : "get", + "type" : "function", "desc" : "Static method to retrieve Element objects. Uses simple caching to consistently return the same object.\nAutomatically fixes if an object was recreated with the same id via AJAX or DOM.", + "sig" : "(el)", + "static" : true, + "memberOf" : "Roo.Element", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -979,15 +1124,20 @@ }, { "name" : "autoHeight", + "type" : "function", "desc" : "Measures the element's content height and updates height to match. Note: this function uses setTimeout so\nthe new height may not be available immediately.", + "sig" : "(animate, duration, onComplete, easing)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "animate", @@ -1024,15 +1174,20 @@ }, { "name" : "scrollIntoView", + "type" : "function", "desc" : "Scrolls this element into view within the passed container.", + "sig" : "(container, hscroll)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -1057,15 +1212,20 @@ }, { "name" : "getAlignToXY", + "type" : "function", "desc" : "Gets the x,y coordinates to align this element with another element. See {@link #alignTo} for more info on the\nsupported position values.", + "sig" : "(element, position, offsets)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "element", @@ -1096,15 +1256,20 @@ }, { "name" : "clearOpacity", + "type" : "function", "desc" : "Clears any opacity settings from this element. Required in some cases for IE.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1116,15 +1281,20 @@ }, { "name" : "setPositioning", + "type" : "function", "desc" : "Set positioning with an object returned by getPositioning().", + "sig" : "(posCfg)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "posCfg", @@ -1143,15 +1313,20 @@ }, { "name" : "getMargins", + "type" : "function", "desc" : "Returns an object with properties top, left, right and bottom representing the margins of this element unless sides is passed,\nthen it returns the calculated width of the sides (see getPadding)", + "sig" : "(sides)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sides", @@ -1170,15 +1345,20 @@ }, { "name" : "setRegion", + "type" : "function", "desc" : "Sets the element's position and size the the specified region. If animation is true then width, height, x and y will be animated concurrently.", + "sig" : "(region, animate)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "region", @@ -1203,15 +1383,20 @@ }, { "name" : "getAttributeNS", + "type" : "function", "desc" : "Returns the value of a namespaced attribute from the element's underlying DOM node.", + "sig" : "(namespace, name)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "namespace", @@ -1236,15 +1421,20 @@ }, { "name" : "setLeft", + "type" : "function", "desc" : "Sets the element's left position directly using CSS style (instead of {@link #setX}).", + "sig" : "(left)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -1263,15 +1453,20 @@ }, { "name" : "load", + "type" : "function", "desc" : "Direct access to the UpdateManager update() method (takes the same parameters).", + "sig" : "(url, params, callback, discardUrl)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "url", @@ -1308,15 +1503,20 @@ }, { "name" : "replaceClass", + "type" : "function", "desc" : "Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added.", + "sig" : "(oldClassName, newClassName)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "oldClassName", @@ -1341,15 +1541,20 @@ }, { "name" : "initDDTarget", + "type" : "function", "desc" : "Initializes a {@link Roo.dd.DDTarget} object for this element.", + "sig" : "(group, config, overrides)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "group", @@ -1380,15 +1585,20 @@ }, { "name" : "setHeight", + "type" : "function", "desc" : "Set the height of the element", + "sig" : "(height, animate)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "height", @@ -1413,15 +1623,20 @@ }, { "name" : "clean", + "type" : "function", "desc" : "Removes worthless text nodes", + "sig" : "(forceReclean)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "forceReclean", @@ -1434,15 +1649,20 @@ }, { "name" : "getPositioning", + "type" : "function", "desc" : "Gets an object with all CSS positioning properties. Useful along with setPostioning to get\nsnapshot before performing an update and then restoring the element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1454,15 +1674,20 @@ }, { "name" : "update", + "type" : "function", "desc" : "Update the innerHTML of this element, optionally searching for and processing scripts", + "sig" : "(html, loadScripts, callback)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "html", @@ -1493,15 +1718,20 @@ }, { "name" : "contains", + "type" : "function", "desc" : "Returns true if this element is an ancestor of the passed element", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -1520,15 +1750,20 @@ }, { "name" : "appendChild", + "type" : "function", "desc" : "Appends the passed element(s) to this element", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -1547,15 +1782,20 @@ }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the value of the \"value\" attribute", + "sig" : "(asNumber)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "asNumber", @@ -1574,15 +1814,20 @@ }, { "name" : "getRegion", + "type" : "function", "desc" : "Returns the region of the given element.\nThe element must be part of the DOM tree to have a region (display:none or elements not appended return false).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1594,15 +1839,20 @@ }, { "name" : "anchorTo", + "type" : "function", "desc" : "Anchors an element to another element and realigns it when the window is resized.", + "sig" : "(element, position, offsets, animate, monitorScroll, callback)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "element", @@ -1651,15 +1901,20 @@ }, { "name" : "removeClass", + "type" : "function", "desc" : "Removes one or more CSS classes from the element.", + "sig" : "(className)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "className", @@ -1678,15 +1933,20 @@ }, { "name" : "radioClass", + "type" : "function", "desc" : "Adds one or more CSS classes to this element and removes the same class(es) from all siblings.", + "sig" : "(className)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "className", @@ -1705,15 +1965,20 @@ }, { "name" : "getWidth", + "type" : "function", "desc" : "Returns the offset width of the element", + "sig" : "(contentWidth)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "contentWidth", @@ -1732,15 +1997,20 @@ }, { "name" : "insertBefore", + "type" : "function", "desc" : "Inserts this element before the passed element in the DOM", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -1759,15 +2029,20 @@ }, { "name" : "getHeight", + "type" : "function", "desc" : "Returns the offset height of the element", + "sig" : "(contentHeight)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "contentHeight", @@ -1786,15 +2061,20 @@ }, { "name" : "setTop", + "type" : "function", "desc" : "Sets the element's top position directly using CSS style (instead of {@link #setY}).", + "sig" : "(top)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "top", @@ -1813,15 +2093,20 @@ }, { "name" : "toggleClass", + "type" : "function", "desc" : "Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it).", + "sig" : "(className)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "className", @@ -1840,15 +2125,20 @@ }, { "name" : "wrap", + "type" : "function", "desc" : "Creates and wraps this element with another element", + "sig" : "(config, returnDom)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -1873,15 +2163,20 @@ }, { "name" : "setVisible", + "type" : "function", "desc" : "Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use\nthe display property to hide the element, otherwise it uses visibility. The default is to hide and show using the visibility property.", + "sig" : "(visible, animate)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1906,15 +2201,20 @@ }, { "name" : "addListener", + "type" : "function", "desc" : "Appends an event handler", + "sig" : "(eventName, fn, scope, options)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1945,15 +2245,20 @@ }, { "name" : "setWidth", + "type" : "function", "desc" : "Set the width of the element", + "sig" : "(width, animate)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -1978,15 +2283,20 @@ }, { "name" : "center", + "type" : "function", "desc" : "Centers the Element in either the viewport, or another Element.", + "sig" : "(centerIn)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "centerIn", @@ -1999,15 +2309,20 @@ }, { "name" : "isVisible", + "type" : "function", "desc" : "Checks whether the element is currently visible using both visibility and display properties.", + "sig" : "(deep)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "deep", @@ -2026,15 +2341,20 @@ }, { "name" : "findParent", + "type" : "function", "desc" : "Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)", + "sig" : "(selector, maxDepth, returnEl)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -2065,15 +2385,20 @@ }, { "name" : "addKeyListener", + "type" : "function", "desc" : "Convenience method for constructing a KeyMap", + "sig" : "(key, fn, scope)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "key", @@ -2104,15 +2429,20 @@ }, { "name" : "swallowEvent", + "type" : "function", "desc" : "Stops the specified event from bubbling and optionally prevents the default action", + "sig" : "(eventName, preventDefault)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -2137,15 +2467,20 @@ }, { "name" : "getStyles", + "type" : "function", "desc" : "Returns an object with properties matching the styles requested.\nFor example, el.getStyles('color', 'font-size', 'width') might return\n{'color': '#FFFFFF', 'font-size': '13px', 'width': '100px'}.", + "sig" : "(style1, style2)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "style1", @@ -2170,15 +2505,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Returns the size of the element.", + "sig" : "(contentSize)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "contentSize", @@ -2197,15 +2537,20 @@ }, { "name" : "endMeasure", + "type" : "function", "desc" : "Restores displays to before beginMeasure was called", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -2217,15 +2562,20 @@ }, { "name" : "getViewSize", + "type" : "function", "desc" : "Returns the width and height of the viewport.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -2237,15 +2587,20 @@ }, { "name" : "addClassOnFocus", + "type" : "function", "desc" : "Sets up event handlers to add and remove a css class when this element has the focus", + "sig" : "(className)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "className", @@ -2264,15 +2619,20 @@ }, { "name" : "alignTo", + "type" : "function", "desc" : "Aligns this element with another element relative to the specified anchor points. If the other element is the\ndocument it aligns it to the viewport.\nThe position parameter is optional, and can be specified in any one of the following formats:\n\nIn addition to the anchor points, the position parameter also supports the \"?\" character. If \"?\" is passed at the end of\nthe position string, the element will attempt to align as specified, but the position will be adjusted to constrain to\nthe viewport if necessary. Note that the element being aligned might be swapped to align to a different position than\nthat specified in order to enforce the viewport constraints.\nFollowing are all of the supported anchor positions:\n
\n    Value  Description\n    -----  -----------------------------\n    tl     The top left corner (default)\n    t      The center of the top edge\n    tr     The top right corner\n    l      The center of the left edge\n    c      In the center of the element\n    r      The center of the right edge\n    bl     The bottom left corner\n    b      The center of the bottom edge\n    br     The bottom right corner\n    
\n Example Usage:\n
\n    // align el to other-el using the default positioning (\"tl-bl\", non-constrained)\n    el.alignTo(\"other-el\");\n\n    // align the top left corner of el with the top right corner of other-el (constrained to viewport)\n    el.alignTo(\"other-el\", \"tr?\");\n\n    // align the bottom right corner of el with the center left edge of other-el\n    el.alignTo(\"other-el\", \"br-l?\");\n\n    // align the center of el with the bottom left corner of other-el and\n    // adjust the x position by -6 pixels (and the y position by 0)\n    el.alignTo(\"other-el\", \"c-bl\", [-6, 0]);\n    
", + "sig" : "(element, position, offsets, animate)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "element", @@ -2309,15 +2669,20 @@ }, { "name" : "insertAfter", + "type" : "function", "desc" : "Inserts this element after the passed element in the DOM", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -2336,15 +2701,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this element - Uses display mode to determine whether to use \"display\" or \"visibility\". See {@link #setVisible}.", + "sig" : "(animate)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "animate", @@ -2363,15 +2733,20 @@ }, { "name" : "setBottom", + "type" : "function", "desc" : "Sets the element's CSS bottom style.", + "sig" : "(bottom)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "bottom", @@ -2390,15 +2765,20 @@ }, { "name" : "clearPositioning", + "type" : "function", "desc" : "Clear positioning back to the default when the document was loaded", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -2417,15 +2797,20 @@ }, { "name" : "isDisplayed", + "type" : "function", "desc" : "Returns true if display is not \"none\"", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -2437,15 +2822,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this element - Uses display mode to determine whether to use \"display\" or \"visibility\". See {@link #setVisible}.", + "sig" : "(animate)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "animate", @@ -2464,15 +2854,20 @@ }, { "name" : "setLeftTop", + "type" : "function", "desc" : "Quick set left and top adding default units", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -2497,15 +2892,20 @@ }, { "name" : "child", + "type" : "function", "desc" : "Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id).", + "sig" : "(selector, returnDom)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -2530,29 +2930,39 @@ }, { "name" : "unmask", + "type" : "function", "desc" : "Removes a previously applied mask. If removeEl is true the mask overlay is destroyed, otherwise\nit is cached for reuse.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "moveTo", + "type" : "function", "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "sig" : "(x, y, animate)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -2583,15 +2993,20 @@ }, { "name" : "addClassOnOver", + "type" : "function", "desc" : "Sets up event handlers to add and remove a css class when the mouse is over this element", + "sig" : "(className, preventFlicker)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "className", @@ -2616,15 +3031,20 @@ }, { "name" : "getLeft", + "type" : "function", "desc" : "Gets the left X coordinate", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -2643,15 +3063,20 @@ }, { "name" : "isScrollable", + "type" : "function", "desc" : "Returns true if this element is scrollable.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -2663,15 +3088,20 @@ }, { "name" : "boxWrap", + "type" : "function", "desc" : "Wraps the specified element with a special markup/CSS block that renders by default as a gray container with a\ngradient background, rounded corners and a 4-way shadow.", + "sig" : "(class)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "class", @@ -2690,15 +3120,20 @@ }, { "name" : "replace", + "type" : "function", "desc" : "Replaces the passed element with this element", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -2717,15 +3152,20 @@ }, { "name" : "select", + "type" : "function", "desc" : "Creates a {@link Roo.CompositeElement} for child nodes based on the passed CSS selector (the selector should not contain an id).", + "sig" : "(selector, unique)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -2750,15 +3190,20 @@ }, { "name" : "isMasked", + "type" : "function", "desc" : "Returns true if this element is masked", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -2770,15 +3215,20 @@ }, { "name" : "getUpdateManager", + "type" : "function", "desc" : "Gets this element's UpdateManager", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -2790,15 +3240,20 @@ }, { "name" : "insertHtml", + "type" : "function", "desc" : "Inserts an html fragment into this element", + "sig" : "(where, html, returnEl)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "where", @@ -2829,15 +3284,20 @@ }, { "name" : "mask", + "type" : "function", "desc" : "Puts a mask over this element to disable user interaction. Requires core.css.\nThis method can only be applied to elements which accept child nodes.", + "sig" : "(msg, msgCls)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -2862,15 +3322,20 @@ }, { "name" : "getTop", + "type" : "function", "desc" : "Gets the top Y coordinate", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -2889,15 +3354,20 @@ }, { "name" : "getBottom", + "type" : "function", "desc" : "Gets the bottom Y coordinate of the element (element Y position + element height)", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -2916,15 +3386,20 @@ }, { "name" : "getRight", + "type" : "function", "desc" : "Gets the right X coordinate of the element (element X position + element width)", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -2943,15 +3418,20 @@ }, { "name" : "beginMeasure", + "type" : "function", "desc" : "Temporarily enables offsets (width,height,x,y) for an element with display:none, use endMeasure() when done.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -2963,15 +3443,20 @@ }, { "name" : "appendTo", + "type" : "function", "desc" : "Appends this element to the passed element", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -2990,15 +3475,20 @@ }, { "name" : "fly", + "type" : "function", "desc" : "Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -\nthe dom node can be overwritten by other code.", + "sig" : "(el, named)", + "static" : true, + "memberOf" : "Roo.Element", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -3023,15 +3513,20 @@ }, { "name" : "hasClass", + "type" : "function", "desc" : "Checks if the specified CSS class exists on this element's DOM node.", + "sig" : "(className)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "className", @@ -3050,29 +3545,39 @@ }, { "name" : "findScrollableParent", + "type" : "function", "desc" : "Looks at the scrollable parent element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "fitToParent", + "type" : "function", "desc" : "Sizes this element to its parent element's dimensions performing\nneccessary box adjustments.", + "sig" : "(monitorResize, targetParent)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "monitorResize", @@ -3097,15 +3602,20 @@ }, { "name" : "setXY", + "type" : "function", "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "sig" : "(pos, animate)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "pos", @@ -3130,15 +3640,20 @@ }, { "name" : "getXY", + "type" : "function", "desc" : "Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -3150,15 +3665,20 @@ }, { "name" : "unselectable", + "type" : "function", "desc" : "Disables text selection for this element (normalized across browsers)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -3170,15 +3690,20 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Tries to blur the element. Any exceptions are caught and ignored.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -3190,15 +3715,20 @@ }, { "name" : "setRight", + "type" : "function", "desc" : "Sets the element's CSS right style.", + "sig" : "(right)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "right", @@ -3217,15 +3747,20 @@ }, { "name" : "findParentNode", + "type" : "function", "desc" : "Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)", + "sig" : "(selector, maxDepth, returnEl)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -3256,15 +3791,20 @@ }, { "name" : "position", + "type" : "function", "desc" : "Initializes positioning on this element. If a desired position is not passed, it will make the\nthe element positioned relative IF it is not already positioned.", + "sig" : "(pos, zIndex, x, y)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "pos", @@ -3295,15 +3835,20 @@ }, { "name" : "getFrameWidth", + "type" : "function", "desc" : "Returns the sum width of the padding and borders for the passed \"sides\". See getBorderWidth()\n for more information about the sides.", + "sig" : "(sides)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sides", @@ -3322,15 +3867,20 @@ }, { "name" : "setLocation", + "type" : "function", "desc" : "Sets the position of the element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "sig" : "(x, y, animate)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -3361,15 +3911,20 @@ }, { "name" : "unclip", + "type" : "function", "desc" : "Return clipping (overflow) to original clipping before clip() was called", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -3381,15 +3936,20 @@ }, { "name" : "set", + "type" : "function", "desc" : "Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)", + "sig" : "(o, useSet)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -3414,15 +3974,20 @@ }, { "name" : "setDisplayed", + "type" : "function", "desc" : "Sets the CSS display property. Uses originalDisplay if the specified value is a boolean true.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -3441,15 +4006,20 @@ }, { "name" : "insertFirst", + "type" : "function", "desc" : "Inserts (or creates) an element (or DomHelper config) as the first child of the this element", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -3468,15 +4038,20 @@ }, { "name" : "animate", + "type" : "function", "desc" : "Perform animation on this element.", + "sig" : "(args, duration, onComplete, easing, animType)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "args", @@ -3519,15 +4094,20 @@ }, { "name" : "enableDisplayMode", + "type" : "function", "desc" : "Convenience method for setVisibilityMode(Element.DISPLAY)", + "sig" : "(display)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "display", @@ -3546,15 +4126,20 @@ }, { "name" : "getComputedWidth", + "type" : "function", "desc" : "Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders\nwhen needed to simulate offsetWidth when offsets aren't available. This may not work on display:none elements\nif a width has not been set using CSS.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -3566,15 +4151,20 @@ }, { "name" : "clip", + "type" : "function", "desc" : "Store the current overflow setting and clip overflow on the element - use {@link #unclip} to remove", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -3586,15 +4176,20 @@ }, { "name" : "setVisibilityMode", + "type" : "function", "desc" : "Sets the element's visibility mode. When setVisible() is called it\nwill use this to determine whether to set the visibility or the display property.", + "sig" : "(visMode)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visMode", @@ -3613,15 +4208,20 @@ }, { "name" : "getColor", + "type" : "function", "desc" : "Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values\nare convert to standard 6 digit hex color.", + "sig" : "(attr, defaultValue, prefix)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "attr", @@ -3646,15 +4246,20 @@ }, { "name" : "insertSibling", + "type" : "function", "desc" : "Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element", + "sig" : "(el, where, returnDom)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -3685,15 +4290,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes an event handler from this element", + "sig" : "(eventName, fn, scope)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -3724,15 +4334,20 @@ }, { "name" : "applyStyles", + "type" : "function", "desc" : "More flexible version of {@link #setStyle} for setting style properties.", + "sig" : "(styles)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "styles", @@ -3751,15 +4366,20 @@ }, { "name" : "getPrevSibling", + "type" : "function", "desc" : "Gets the previous sibling, skipping text nodes", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -3771,15 +4391,20 @@ }, { "name" : "setBox", + "type" : "function", "desc" : "Sets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x and y will be animated concurrently.", + "sig" : "(box, adjust, animate)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -3810,15 +4435,20 @@ }, { "name" : "initDDProxy", + "type" : "function", "desc" : "Initializes a {@link Roo.dd.DDProxy} object for this element.", + "sig" : "(group, config, overrides)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "group", @@ -3849,15 +4479,20 @@ }, { "name" : "setX", + "type" : "function", "desc" : "Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "sig" : "(The, animate)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "The", @@ -3882,15 +4517,20 @@ }, { "name" : "setY", + "type" : "function", "desc" : "Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", + "sig" : "(The, animate)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "The", @@ -3915,15 +4555,20 @@ }, { "name" : "query", + "type" : "function", "desc" : "Selects child nodes based on the passed CSS selector (the selector should not contain an id).", + "sig" : "(selector)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -3942,15 +4587,20 @@ }, { "name" : "getAnchorXY", + "type" : "function", "desc" : "Gets the x,y coordinates specified by the anchor position on the element.", + "sig" : "(anchor, size, local)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "anchor", @@ -3981,15 +4631,20 @@ }, { "name" : "initDD", + "type" : "function", "desc" : "Initializes a {@link Roo.dd.DD} drag drop object for this element.", + "sig" : "(group, config, overrides)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "group", @@ -4020,15 +4675,20 @@ }, { "name" : "getComputedHeight", + "type" : "function", "desc" : "Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders\nwhen needed to simulate offsetHeight when offsets aren't available. This may not work on display:none elements\nif a height has not been set using CSS.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -4040,15 +4700,20 @@ }, { "name" : "is", + "type" : "function", "desc" : "Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child)", + "sig" : "(selector)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -4067,15 +4732,20 @@ }, { "name" : "move", + "type" : "function", "desc" : "Move this element relative to its current position.", + "sig" : "(direction, distance, animate)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "direction", @@ -4106,29 +4776,39 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Removes this element from the DOM and deletes it from the cache", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getNextSibling", + "type" : "function", "desc" : "Gets the next sibling, skipping text nodes", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -4140,15 +4820,20 @@ }, { "name" : "getStyle", + "type" : "function", "desc" : "Normalizes currentStyle and computedStyle. This is not YUI getStyle, it is an optimised version.", + "sig" : "(property)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "property", @@ -4167,15 +4852,20 @@ }, { "name" : "isBorderBox", + "type" : "function", "desc" : "Tests various css rules/browsers to determine if this element uses a border box", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -4187,15 +4877,20 @@ }, { "name" : "getPadding", + "type" : "function", "desc" : "Gets the width of the padding(s) for the specified side(s)", + "sig" : "(side)", + "static" : false, + "memberOf" : "Roo.Element", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Element", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "side", diff --git a/docs/symbols/Roo.LayoutDialog.json b/docs/symbols/Roo.LayoutDialog.json index 4288169de4..dda05c0ff6 100644 --- a/docs/symbols/Roo.LayoutDialog.json +++ b/docs/symbols/Roo.LayoutDialog.json @@ -28,223 +28,237 @@ } ], "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", - "optvals" : [] + "name" : "buttons[]", + "type" : "Roo.Button", + "desc" : "Bottom buttons..", + "memberOf" : "" }, { - "name" : "y", + "name" : "minButtonWidth", "type" : "Number", - "desc" : "The default top page coordinate of the dialog (defaults to center screen)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "desc" : "Minimum width of all dialog buttons (defaults to 75)", + "memberOf" : "Roo.BasicDialog" }, { - "name" : "modal", + "name" : "west", + "type" : "Roo.LayoutRegion", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "fixedcenter", "type" : "Boolean", - "desc" : "True to show the dialog modally, preventing user interaction with the rest of the page (defaults to false)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "desc" : "True to ensure that anytime the dialog is shown or resized it gets centered (defaults to false)", + "memberOf" : "Roo.BasicDialog" }, { - "name" : "animateTarget", - "type" : "String/Element", - "desc" : "Id or element from which the dialog should animate while opening\n(defaults to null with no animation)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "name" : "minWidth", + "type" : "Number", + "desc" : "The minimum allowable width for a resizable dialog (defaults to 200)", + "memberOf" : "Roo.BasicDialog" }, { - "name" : "shadow", - "type" : "Boolean/String", - "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right\nshadow (defaults to false)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "name" : "title", + "type" : "String", + "desc" : "Default text to display in the title bar (defaults to null)", + "memberOf" : "Roo.BasicDialog" }, { - "name" : "autoScroll", + "name" : "center", + "type" : "Roo.LayoutRegion", + "desc" : "", + "memberOf" : "" + }, + { + "name" : "resizable", "type" : "Boolean", - "desc" : "True to allow the dialog body contents to overflow and display scrollbars (defaults to false)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "desc" : "False to disable manual dialog resizing (defaults to true)", + "memberOf" : "Roo.BasicDialog" }, { - "name" : "collapsible", + "name" : "resizeHandles", + "type" : "String", + "desc" : "Which resize handles to display - see the {@link Roo.Resizable} handles config\nproperty for valid values (defaults to 'all')", + "memberOf" : "Roo.BasicDialog" + }, + { + "name" : "width", + "type" : "Number", + "desc" : "Width of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.", + "memberOf" : "Roo.BasicDialog" + }, + { + "name" : "shim", "type" : "Boolean", - "desc" : "False to remove the built-in top-right corner collapse button (defaults to true)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "desc" : "True to create an iframe shim that prevents selects from showing through (defaults to false)", + "memberOf" : "Roo.BasicDialog" + }, + { + "name" : "proxyDrag", + "type" : "Boolean", + "desc" : "True to drag a lightweight proxy element rather than the dialog itself, used when\ndraggable = true (defaults to false)", + "memberOf" : "Roo.BasicDialog" }, { "name" : "autoTabs", "type" : "Boolean", "desc" : "If true, all elements with class 'x-dlg-tab' will get automatically converted to tabs (defaults to false)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "Roo.BasicDialog" }, { - "name" : "shadowOffset", + "name" : "height", "type" : "Number", - "desc" : "The number of pixels to offset the shadow if displayed (defaults to 5)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "desc" : "Height of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.", + "memberOf" : "Roo.BasicDialog" }, { - "name" : "buttons", - "type" : "Array", - "desc" : "Array of buttons", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "name" : "constraintoviewport", + "type" : "Boolean", + "desc" : "True to keep the dialog constrained within the visible viewport boundaries (defaults to true)", + "memberOf" : "Roo.BasicDialog" }, { - "name" : "minButtonWidth", + "name" : "shadowOffset", "type" : "Number", - "desc" : "Minimum width of all dialog buttons (defaults to 75)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "desc" : "The number of pixels to offset the shadow if displayed (defaults to 5)", + "memberOf" : "Roo.BasicDialog" }, { - "name" : "title", - "type" : "String", - "desc" : "Default text to display in the title bar (defaults to null)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "name" : "draggable", + "type" : "Boolean", + "desc" : "False to disable dragging of the dialog within the viewport (defaults to true)", + "memberOf" : "Roo.BasicDialog" }, { - "name" : "minWidth", - "type" : "Number", - "desc" : "The minimum allowable width for a resizable dialog (defaults to 200)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "name" : "listeners", + "type" : "Object", + "desc" : "list of events and 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" : "buttonAlign", - "type" : "String", - "desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"right\")", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "name" : "south", + "type" : "Roo.LayoutRegion", + "desc" : "", + "memberOf" : "" }, { - "name" : "autoCreate", - "type" : "Boolean/DomHelper", - "desc" : "True to auto create from scratch, or using a DomHelper Object (defaults to false)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "name" : "east", + "type" : "Roo.LayoutRegion", + "desc" : "", + "memberOf" : "" }, { - "name" : "minHeight", - "type" : "Number", - "desc" : "The minimum allowable height for a resizable dialog (defaults to 80)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "name" : "shadow", + "type" : "Boolean/String", + "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right\nshadow (defaults to false)", + "memberOf" : "Roo.BasicDialog" }, { - "name" : "proxyDrag", - "type" : "Boolean", - "desc" : "True to drag a lightweight proxy element rather than the dialog itself, used when\ndraggable = true (defaults to false)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "name" : "x", + "type" : "Number", + "desc" : "The default left page coordinate of the dialog (defaults to center screen)", + "memberOf" : "Roo.BasicDialog" }, { - "name" : "shim", + "name" : "collapsible", "type" : "Boolean", - "desc" : "True to create an iframe shim that prevents selects from showing through (defaults to false)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "desc" : "False to remove the built-in top-right corner collapse button (defaults to true)", + "memberOf" : "Roo.BasicDialog" }, { - "name" : "width", + "name" : "y", "type" : "Number", - "desc" : "Width of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] - }, - { - "name" : "constraintoviewport", - "type" : "Boolean", - "desc" : "True to keep the dialog constrained within the visible viewport boundaries (defaults to true)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "desc" : "The default top page coordinate of the dialog (defaults to center screen)", + "memberOf" : "Roo.BasicDialog" }, { - "name" : "syncHeightBeforeShow", - "type" : "Boolean", - "desc" : "True to cause the dimensions to be recalculated before the dialog is shown (defaults to false)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "name" : "north", + "type" : "Roo.LayoutRegion", + "desc" : "", + "memberOf" : "" }, { - "name" : "tabTag", - "type" : "String", - "desc" : "The tag name of tab elements, used when autoTabs = true (defaults to 'div')", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "name" : "buttons", + "type" : "Array", + "desc" : "Array of buttons", + "memberOf" : "Roo.BasicDialog" }, { - "name" : "resizable", - "type" : "Boolean", - "desc" : "False to disable manual dialog resizing (defaults to true)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "name" : "animateTarget", + "type" : "String/Element", + "desc" : "Id or element from which the dialog should animate while opening\n(defaults to null with no animation)", + "memberOf" : "Roo.BasicDialog" }, { "name" : "closable", "type" : "Boolean", "desc" : "False to remove the built-in top-right corner close button (defaults to true)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "memberOf" : "Roo.BasicDialog" }, { - "name" : "fixedcenter", + "name" : "autoCreate", + "type" : "Boolean/DomHelper", + "desc" : "True to auto create from scratch, or using a DomHelper Object (defaults to false)", + "memberOf" : "Roo.BasicDialog" + }, + { + "name" : "autoScroll", "type" : "Boolean", - "desc" : "True to ensure that anytime the dialog is shown or resized it gets centered (defaults to false)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "desc" : "True to allow the dialog body contents to overflow and display scrollbars (defaults to false)", + "memberOf" : "Roo.BasicDialog" }, { - "name" : "height", - "type" : "Number", - "desc" : "Height of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "name" : "modal", + "type" : "Boolean", + "desc" : "True to show the dialog modally, preventing user interaction with the rest of the page (defaults to false)", + "memberOf" : "Roo.BasicDialog" }, { - "name" : "resizeHandles", + "name" : "tabTag", "type" : "String", - "desc" : "Which resize handles to display - see the {@link Roo.Resizable} handles config\nproperty for valid values (defaults to 'all')", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "desc" : "The tag name of tab elements, used when autoTabs = true (defaults to 'div')", + "memberOf" : "Roo.BasicDialog" }, { - "name" : "x", + "name" : "minHeight", "type" : "Number", - "desc" : "The default left page coordinate of the dialog (defaults to center screen)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "desc" : "The minimum allowable height for a resizable dialog (defaults to 80)", + "memberOf" : "Roo.BasicDialog" }, { - "name" : "draggable", + "name" : "syncHeightBeforeShow", "type" : "Boolean", - "desc" : "False to disable dragging of the dialog within the viewport (defaults to true)", - "memberOf" : "Roo.BasicDialog", - "optvals" : [] + "desc" : "True to cause the dimensions to be recalculated before the dialog is shown (defaults to false)", + "memberOf" : "Roo.BasicDialog" + }, + { + "name" : "buttonAlign", + "type" : "String", + "desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"right\")", + "memberOf" : "Roo.BasicDialog" } ], "methods" : [ { "name" : "addxtype", + "type" : "function", "desc" : "Add an xtype element (actually adds to the layout.)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -256,15 +270,20 @@ }, { "name" : "getLayout", + "type" : "function", "desc" : "Get the BorderLayout for this dialog", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -276,57 +295,77 @@ }, { "name" : "endUpdate", + "type" : "function", "desc" : "Ends update of the layout and resets display to none. Use standard beginUpdate/endUpdate on the layout.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutDialog", "example" : "", "deprecated" : "This has been deprecated: ", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "beginUpdate", + "type" : "function", "desc" : "Begins an update of the layout and sets display to block and visibility to hidden. Use standard beginUpdate/endUpdate on the layout.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutDialog", "example" : "", "deprecated" : "This has been deprecated: ", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "expand", + "type" : "function", "desc" : "Expands a collapsed dialog back to its normal state. Equivalent to the user\nclicking the expand dialog button.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BasicDialog", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "alignTo", + "type" : "function", "desc" : "Aligns the dialog to the specified element", + "sig" : "(element, position, offsets)", + "static" : false, + "memberOf" : "Roo.BasicDialog", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "element", @@ -357,15 +396,20 @@ }, { "name" : "setTitle", + "type" : "function", "desc" : "Sets the dialog title text", + "sig" : "(text)", + "static" : false, + "memberOf" : "Roo.BasicDialog", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "text", @@ -384,15 +428,20 @@ }, { "name" : "isVisible", + "type" : "function", "desc" : "Returns true if the dialog is visible", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BasicDialog", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -404,15 +453,20 @@ }, { "name" : "resizeTo", + "type" : "function", "desc" : "Resizes the dialog.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BasicDialog", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -437,15 +491,20 @@ }, { "name" : "center", + "type" : "function", "desc" : "Centers this dialog in the viewport", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BasicDialog", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -457,29 +516,39 @@ }, { "name" : "collapse", + "type" : "function", "desc" : "Collapses the dialog to its minimized state (only the title bar is visible).\nEquivalent to the user clicking the collapse dialog button.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BasicDialog", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "initTabs", + "type" : "function", "desc" : "Reinitializes the tabs component, clearing out old tabs and finding new ones.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BasicDialog", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -491,15 +560,20 @@ }, { "name" : "toFront", + "type" : "function", "desc" : "Brings this dialog to the front of any other visible dialogs", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BasicDialog", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -511,15 +585,20 @@ }, { "name" : "moveTo", + "type" : "function", "desc" : "Moves the dialog's top-left corner to the specified point", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BasicDialog", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -544,15 +623,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hides the dialog.", + "sig" : "(callback)", + "static" : false, + "memberOf" : "Roo.BasicDialog", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "callback", @@ -571,15 +655,20 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Destroys this dialog and all its supporting elements (including any tabs, shim,\nshadow, proxy, mask, etc.) Also removes all event listeners.", + "sig" : "(removeEl)", + "static" : false, + "memberOf" : "Roo.BasicDialog", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "removeEl", @@ -592,15 +681,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Shows the dialog.", + "sig" : "(animateTarget)", + "static" : false, + "memberOf" : "Roo.BasicDialog", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "animateTarget", @@ -619,15 +713,20 @@ }, { "name" : "anchorTo", + "type" : "function", "desc" : "Anchors an element to another element and realigns it when the window is resized.", + "sig" : "(element, position, offsets, monitorScroll)", + "static" : false, + "memberOf" : "Roo.BasicDialog", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "element", @@ -664,15 +763,20 @@ }, { "name" : "addButton", + "type" : "function", "desc" : "Adds a button to the footer section of the dialog.", + "sig" : "(config, handler, scope)", + "static" : false, + "memberOf" : "Roo.BasicDialog", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -703,15 +807,20 @@ }, { "name" : "addKeyListener", + "type" : "function", "desc" : "Adds a key listener for when this dialog is displayed. This allows you to hook in a function that will be\nexecuted in response to a particular key being pressed while the dialog is active.", + "sig" : "(key, fn, scope)", + "static" : false, + "memberOf" : "Roo.BasicDialog", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "key", @@ -742,29 +851,39 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Focuses the dialog. If a defaultButton is set, it will receive focus, otherwise the\ndialog itself will receive focus.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BasicDialog", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getTabs", + "type" : "function", "desc" : "Returns the TabPanel component (creates it if it doesn't exist).\nNote: If you wish to simply check for the existence of tabs without creating them,\ncheck for a null 'tabs' property.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BasicDialog", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -776,15 +895,20 @@ }, { "name" : "setDefaultButton", + "type" : "function", "desc" : "Sets the default button to be focused when the dialog is displayed.", + "sig" : "(btn)", + "static" : false, + "memberOf" : "Roo.BasicDialog", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "btn", @@ -803,15 +927,20 @@ }, { "name" : "toBack", + "type" : "function", "desc" : "Sends this dialog to the back (under) of any other visible dialogs", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BasicDialog", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -823,15 +952,20 @@ }, { "name" : "setContentSize", + "type" : "function", "desc" : "Resizes the dialog to fit the specified content size.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BasicDialog", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -856,15 +990,20 @@ }, { "name" : "restoreState", + "type" : "function", "desc" : "Restores the previous state of the dialog if Roo.state is configured.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BasicDialog", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -876,15 +1015,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the element for this dialog", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BasicDialog", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -896,29 +1040,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -949,15 +1103,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -982,15 +1141,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1003,15 +1167,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1024,15 +1193,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1057,15 +1231,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1090,15 +1269,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1117,15 +1301,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1150,15 +1339,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1191,7 +1385,9 @@ "events" : [ { "name" : "move", + "type" : "function", "desc" : "Fires when this dialog is moved by the user.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", @@ -1221,7 +1417,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires when this dialog is resized by the user.", + "sig" : "function (_self, width, height)\n{\n\n}", "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", @@ -1251,7 +1449,9 @@ }, { "name" : "beforehide", + "type" : "function", "desc" : "Fires before this dialog is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", @@ -1269,7 +1469,9 @@ }, { "name" : "beforeshow", + "type" : "function", "desc" : "Fires before this dialog is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", @@ -1287,7 +1489,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires when this dialog is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", @@ -1305,7 +1509,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires when this dialog is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", @@ -1323,7 +1529,9 @@ }, { "name" : "keydown", + "type" : "function", "desc" : "Fires when a key is pressed", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.BasicDialog", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.LayoutManager.json b/docs/symbols/Roo.LayoutManager.json index 7768a8cd35..19a6748c42 100644 --- a/docs/symbols/Roo.LayoutManager.json +++ b/docs/symbols/Roo.LayoutManager.json @@ -14,27 +14,33 @@ "see" : "", "params" : [], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" } ], "methods" : [ { "name" : "getRegion", + "type" : "function", "desc" : "Returns the specified region.", + "sig" : "(target)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -53,29 +59,39 @@ }, { "name" : "beginUpdate", + "type" : "function", "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isUpdating", + "type" : "function", "desc" : "Returns true if this layout is currently being updated", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -87,15 +103,20 @@ }, { "name" : "getViewSize", + "type" : "function", "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -107,15 +128,20 @@ }, { "name" : "endUpdate", + "type" : "function", "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout", + "sig" : "(noLayout)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "noLayout", @@ -128,15 +154,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the Element this layout is bound to.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -148,29 +179,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -201,15 +242,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -234,15 +280,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -255,15 +306,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -276,15 +332,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -309,15 +370,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -342,15 +408,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -369,15 +440,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -402,15 +478,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -443,8 +524,10 @@ "events" : [ { "name" : "layout", + "type" : "function", "desc" : "Fires when a layout is performed.", - "memberOf" : "Roo.LayoutManager", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -461,8 +544,10 @@ }, { "name" : "regionexpanded", + "type" : "function", "desc" : "Fires when a region is expanded.", - "memberOf" : "Roo.LayoutManager", + "sig" : "function (region)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -479,8 +564,10 @@ }, { "name" : "regionresized", + "type" : "function", "desc" : "Fires when the user resizes a region.", - "memberOf" : "Roo.LayoutManager", + "sig" : "function (region, newSize)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -503,8 +590,10 @@ }, { "name" : "regioncollapsed", + "type" : "function", "desc" : "Fires when a region is collapsed.", - "memberOf" : "Roo.LayoutManager", + "sig" : "function (region)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.LayoutRegion.json b/docs/symbols/Roo.LayoutRegion.json index 694aff9d54..165b1ca04a 100644 --- a/docs/symbols/Roo.LayoutRegion.json +++ b/docs/symbols/Roo.LayoutRegion.json @@ -15,219 +15,195 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "cmargins", "type" : "Object", "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "alwaysShowTabs", "type" : "Boolean", "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "margins", "type" : "Object", "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "preferredTabWidth", "type" : "Number", "desc" : "The preferred tab width (defaults to 150)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "disableTabTips", "type" : "Boolean", "desc" : "True to disable tab tooltips", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "collapsible", "type" : "Boolean", "desc" : "False to disable collapsing (defaults to true)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "collapsedTitle", "type" : "String", "desc" : "Optional string message to display in the collapsed block of a north or south region", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "autoScroll", "type" : "Boolean", "desc" : "True to enable overflow scrolling (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "hidden", "type" : "Boolean", "desc" : "True to start the region hidden (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "toolbar", "type" : "Boolean", "desc" : "xtype configuration for a toolbar - shows on right of tabbar", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "title", "type" : "String", "desc" : "The title for the region (overrides panel titles)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "hideWhenEmpty", "type" : "Boolean", "desc" : "True to hide the region when it has no panels", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "collapsed", "type" : "Boolean", "desc" : "True to set the initial display to collapsed (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "hideTabs", "type" : "Boolean", "desc" : "True to hide the tab strip (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "resizeTabs", "type" : "Boolean", "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "tabPosition", "type" : "String", "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [ - "top", - "bottom" - ] + "memberOf" : "" }, { "name" : "width", "type" : "Number", "desc" : "For East/West panels", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "floatable", "type" : "Boolean", "desc" : "False to disable floating (defaults to true)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "minTabWidth", "type" : "Number", "desc" : "The minimum tab width (defaults to 40)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "split", "type" : "Boolean", "desc" : "To show the splitter", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "titlebar", "type" : "Boolean", "desc" : "True to display a title bar (defaults to true)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "preservePanels", "type" : "Boolean", "desc" : "True to preserve removed panels so they can be readded later (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "closeOnTab", "type" : "Boolean", "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "height", "type" : "Number", "desc" : "For North/South panels", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "animate", "type" : "Boolean", "desc" : "True to animate expand/collapse (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "autoHide", "type" : "Boolean", "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" }, { "name" : "showPin", "type" : "Boolean", "desc" : "True to show a pin button", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "getEl", + "type" : "function", "desc" : "Returns the container element for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -239,15 +215,20 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.", + "sig" : "(panel, preservePanel)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -272,15 +253,20 @@ }, { "name" : "getActivePanel", + "type" : "function", "desc" : "Get the active panel for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -292,15 +278,20 @@ }, { "name" : "collapse", + "type" : "function", "desc" : "Collapses this region.", + "sig" : "(skipAnim)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "skipAnim", @@ -313,15 +304,20 @@ }, { "name" : "unhidePanel", + "type" : "function", "desc" : "Unhides the tab for a previously hidden panel.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -334,15 +330,20 @@ }, { "name" : "setCollapsedTitle", + "type" : "function", "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)", + "sig" : "(title)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "title", @@ -355,15 +356,20 @@ }, { "name" : "getTabs", + "type" : "function", "desc" : "Returns the TabPanel component used by this region", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -375,15 +381,20 @@ }, { "name" : "expand", + "type" : "function", "desc" : "Expands this region if it was previously collapsed.", + "sig" : "(e, skipAnim)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -402,15 +413,20 @@ }, { "name" : "isVisible", + "type" : "function", "desc" : "Returns true if this region is currently visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -422,15 +438,20 @@ }, { "name" : "showPanel", + "type" : "function", "desc" : "Shows the specified panel.", + "sig" : "(panelId)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panelId", @@ -449,43 +470,58 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hides this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "show", + "type" : "function", "desc" : "Shows this region if it was previously hidden.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "add", + "type" : "function", "desc" : "Adds the passed ContentPanel(s) to this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -504,15 +540,20 @@ }, { "name" : "hidePanel", + "type" : "function", "desc" : "Hides the tab for the specified panel.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -525,15 +566,20 @@ }, { "name" : "hasPanel", + "type" : "function", "desc" : "Returns true if the panel is in this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.BasicLayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -552,15 +598,20 @@ }, { "name" : "resizeTo", + "type" : "function", "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.", + "sig" : "(newSize)", + "static" : false, + "memberOf" : "Roo.BasicLayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "newSize", @@ -573,15 +624,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Returns this regions position (north/south/east/west/center).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BasicLayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -593,15 +649,20 @@ }, { "name" : "getPanel", + "type" : "function", "desc" : "Returns the panel specified or null if it's not in this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.BasicLayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -620,29 +681,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -673,15 +744,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -706,15 +782,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -727,15 +808,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -748,15 +834,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -781,15 +872,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -814,15 +910,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -841,15 +942,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -874,15 +980,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -915,7 +1026,9 @@ "events" : [ { "name" : "paneladded", + "type" : "function", "desc" : "Fires when a panel is added.", + "sig" : "function (_self, panel)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -939,7 +1052,9 @@ }, { "name" : "invalidated", + "type" : "function", "desc" : "Fires when the layout for this region is changed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -957,7 +1072,9 @@ }, { "name" : "expanded", + "type" : "function", "desc" : "Fires when this region is expanded.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -975,7 +1092,9 @@ }, { "name" : "beforeremove", + "type" : "function", "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.", + "sig" : "function (_self, panel, e)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1005,7 +1124,9 @@ }, { "name" : "collapsed", + "type" : "function", "desc" : "Fires when this region is collapsed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1023,7 +1144,9 @@ }, { "name" : "panelremoved", + "type" : "function", "desc" : "Fires when a panel is removed.", + "sig" : "function (_self, panel)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1047,7 +1170,9 @@ }, { "name" : "beforecollapse", + "type" : "function", "desc" : "Fires when this region before collapse.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1065,7 +1190,9 @@ }, { "name" : "slidehide", + "type" : "function", "desc" : "Fires when this region slides out of view.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1083,7 +1210,9 @@ }, { "name" : "visibilitychange", + "type" : "function", "desc" : "Fires when this region is shown or hidden", + "sig" : "function (_self, visibility)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1107,7 +1236,9 @@ }, { "name" : "slideshow", + "type" : "function", "desc" : "Fires when this region is slid into view.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1125,7 +1256,9 @@ }, { "name" : "panelactivated", + "type" : "function", "desc" : "Fires when a panel is activated.", + "sig" : "function (_self, panel)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1149,7 +1282,9 @@ }, { "name" : "resized", + "type" : "function", "desc" : "Fires when the user resizes this region.", + "sig" : "function (_self, newSize)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.LoadMask.json b/docs/symbols/Roo.LoadMask.json index ec16d97c7f..4068651082 100644 --- a/docs/symbols/Roo.LoadMask.json +++ b/docs/symbols/Roo.LoadMask.json @@ -25,55 +25,64 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "msg", "type" : "String", "desc" : "The text to display in a centered loading message box (defaults to 'Loading...')", - "memberOf" : "Roo.LoadMask", - "optvals" : [] + "memberOf" : "" }, { "name" : "removeMask", "type" : "Boolean", "desc" : "True to create a single-use mask that is automatically destroyed after loading (useful for page loads),\nFalse to persist the mask element reference for multiple uses (e.g., for paged data widgets). Defaults to false.", - "memberOf" : "Roo.LoadMask", - "optvals" : [] + "memberOf" : "" }, { "name" : "msgCls", "type" : "String", "desc" : "The CSS class to apply to the loading message element (defaults to \"x-mask-loading\")", - "memberOf" : "Roo.LoadMask", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "disable", + "type" : "function", "desc" : "Disables the mask to prevent it from being displayed", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LoadMask", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "enable", + "type" : "function", "desc" : "Enables the mask so that it can be displayed", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LoadMask", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] } diff --git a/docs/symbols/Roo.MasterTemplate.json b/docs/symbols/Roo.MasterTemplate.json index 9c86f916a0..0728237cfe 100644 --- a/docs/symbols/Roo.MasterTemplate.json +++ b/docs/symbols/Roo.MasterTemplate.json @@ -14,41 +14,45 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "onLoad", "type" : "Function", "desc" : "Called after the template has been loaded and complied (usually from a remove source)", - "memberOf" : "Roo.Template", - "optvals" : [] + "memberOf" : "Roo.Template" }, { "name" : "html", "type" : "String", "desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")", - "memberOf" : "Roo.Template", - "optvals" : [] + "memberOf" : "Roo.Template" }, { "name" : "url", "type" : "String", "desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n it should be fixed so that template is observable...", - "memberOf" : "Roo.Template", - "optvals" : [] + "memberOf" : "Roo.Template" } ], "methods" : [ { "name" : "fill", + "type" : "function", "desc" : "Applies all the passed values to a child template.", + "sig" : "(name, values, reset)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.MasterTemplate", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "name", @@ -79,15 +83,20 @@ }, { "name" : "add", + "type" : "function", "desc" : "Applies the passed values to a child template.", + "sig" : "(name, values)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.MasterTemplate", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "name", @@ -112,15 +121,20 @@ }, { "name" : "from", + "type" : "function", "desc" : "Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML. e.g.\nvar tpl = Roo.MasterTemplate.from('element-id');", + "sig" : "(el, config)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.MasterTemplate", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -139,15 +153,20 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the template for reuse", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.MasterTemplate", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -159,29 +178,39 @@ }, { "name" : "addAll", + "type" : "function", "desc" : "Alias for fill().", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.MasterTemplate", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "insertFirst", + "type" : "function", "desc" : "Applies the supplied values to the template and inserts the new node(s) as the first child of el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -212,15 +241,20 @@ }, { "name" : "overwrite", + "type" : "function", "desc" : "Applies the supplied values to the template and overwrites the content of el with the new node(s).", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -251,15 +285,20 @@ }, { "name" : "insertBefore", + "type" : "function", "desc" : "Applies the supplied values to the template and inserts the new node(s) before el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -290,15 +329,20 @@ }, { "name" : "applyTemplate", + "type" : "function", "desc" : "Returns an HTML fragment of this template with the specified values applied.", + "sig" : "(values)", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "values", @@ -317,15 +361,20 @@ }, { "name" : "compile", + "type" : "function", "desc" : "Compiles the template into an internal function, eliminating the RegEx overhead.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -337,15 +386,20 @@ }, { "name" : "set", + "type" : "function", "desc" : "Sets the HTML used as the template and optionally compiles it.", + "sig" : "(html, compile)", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "html", @@ -370,15 +424,20 @@ }, { "name" : "insertAfter", + "type" : "function", "desc" : "Applies the supplied values to the template and inserts the new node(s) after el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -409,15 +468,20 @@ }, { "name" : "append", + "type" : "function", "desc" : "Applies the supplied values to the template and appends the new node(s) to el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -448,15 +512,20 @@ }, { "name" : "apply", + "type" : "function", "desc" : "Alias for {@link #applyTemplate}", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] } diff --git a/docs/symbols/Roo.NestedLayoutPanel.json b/docs/symbols/Roo.NestedLayoutPanel.json index ca4c1b8f4a..bc6404ae0e 100644 --- a/docs/symbols/Roo.NestedLayoutPanel.json +++ b/docs/symbols/Roo.NestedLayoutPanel.json @@ -17,7 +17,7 @@ { "name" : "layout", "type" : "Roo.BorderLayout", - "desc" : "The layout for this panel", + "desc" : "[required] The layout for this panel", "isOptional" : false }, { @@ -28,145 +28,135 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "loadOnce", "type" : "Boolean", "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "autoScroll", "type" : "Boolean", "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "fitToFrame", "type" : "Boolean", "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "background", "type" : "Boolean", "desc" : "True if the panel should not be activated when it is added (defaults to false)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "toolbar", - "type" : "Toolbar", + "type" : "Roo.Toolbar", "desc" : "A toolbar for this panel", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "region", "type" : "String", - "desc" : "t) which region to put this panel on (when used with xtype constructors)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [ - "center", - "north", - "south", - "east", - "west" - ] + "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)", + "memberOf" : "Roo.ContentPanel" }, { "name" : "content", "type" : "String", "desc" : "Raw content to fill content panel with (uses setContent on construction.)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "menu", + "type" : "Roo.menu.Menu", + "desc" : "popup menu", + "memberOf" : "Roo.ContentPanel" }, { "name" : "title", "type" : "String", "desc" : "The title for this panel", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "style", "type" : "String", "desc" : "Extra style to add to the content panel", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "autoCreate", - "type" : "Boolean/Object", + "type" : "Boolean|Object", "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "fitContainer", "type" : "Boolean", "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "closable", "type" : "Boolean", "desc" : "True if the panel can be closed/removed", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "params", - "type" : "String/Object", + "type" : "String|Object", "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "adjustments", "type" : "Array", "desc" : "Values to add to the width/height when doing a {@link #fitToFrame} (default is [0, 0])", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "url", "type" : "String", "desc" : "Calls {@link #setUrl} with this value", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "resizeEl", - "type" : "String/HTMLElement/Element", + "type" : "String|HTMLElement|Element", "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" } ], "methods" : [ { "name" : "addxtype", + "type" : "function", "desc" : "Adds a xtype elements to the layout of the nested panel\n
\n\npanel.addxtype({\n       xtype : 'ContentPanel',\n       region: 'west',\n       items: [ .... ]\n   }\n);\n\npanel.addxtype({\n        xtype : 'NestedLayoutPanel',\n        region: 'west',\n        layout: {\n           center: { },\n           west: { }   \n        },\n        items : [ ... list of content panels or nested layout panels.. ]\n   }\n);\n
", + "sig" : "(cfg)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.NestedLayoutPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cfg", @@ -179,15 +169,20 @@ }, { "name" : "getLayout", + "type" : "function", "desc" : "Returns the nested BorderLayout for this panel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.NestedLayoutPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -199,15 +194,20 @@ }, { "name" : "load", + "type" : "function", "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.", + "sig" : "(url, params, callback, discardUrl)", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "url", @@ -244,15 +244,20 @@ }, { "name" : "getUpdateManager", + "type" : "function", "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -264,15 +269,20 @@ }, { "name" : "isClosable", + "type" : "function", "desc" : "Returns true is this panel was configured to be closable", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -284,29 +294,39 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Destroys this panel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getEl", + "type" : "function", "desc" : "Returns this panel's element - used by regiosn to add.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -318,15 +338,20 @@ }, { "name" : "setContent", + "type" : "function", "desc" : "Updates this panel's element", + "sig" : "(content, loadScripts)", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "content", @@ -345,15 +370,20 @@ }, { "name" : "getId", + "type" : "function", "desc" : "Returns this panel's id", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -365,29 +395,39 @@ }, { "name" : "refresh", + "type" : "function", "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getTitle", + "type" : "function", "desc" : "Returns this panel's title", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -399,15 +439,20 @@ }, { "name" : "setTitle", + "type" : "function", "desc" : "Set this panel's title", + "sig" : "(title)", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "title", @@ -420,15 +465,20 @@ }, { "name" : "getToolbar", + "type" : "function", "desc" : "Returns the toolbar for this Panel if one was configured.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -440,15 +490,20 @@ }, { "name" : "setUrl", + "type" : "function", "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.", + "sig" : "(url, params, loadOnce)", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "url", @@ -479,29 +534,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -532,15 +597,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -565,15 +635,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -586,15 +661,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -607,15 +687,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -640,15 +725,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -673,15 +763,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -700,15 +795,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -733,15 +833,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -774,7 +879,9 @@ "events" : [ { "name" : "deactivate", + "type" : "function", "desc" : "Fires when this panel is activated.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", @@ -792,7 +899,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires when this panel is resized if fitToFrame is true.", + "sig" : "function (_self, width, height)\n{\n\n}", "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", @@ -822,7 +931,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires when this tab is created", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", @@ -840,7 +951,9 @@ }, { "name" : "activate", + "type" : "function", "desc" : "Fires when this panel is activated.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.PagingToolbar.json b/docs/symbols/Roo.PagingToolbar.json index 20ded8e969..219d257744 100644 --- a/docs/symbols/Roo.PagingToolbar.json +++ b/docs/symbols/Roo.PagingToolbar.json @@ -21,76 +21,75 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "text", "type" : "string", "desc" : "", - "memberOf" : "Roo.Toolbar", - "optvals" : [] + "memberOf" : "Roo.Toolbar" }, { "name" : "pageSize", "type" : "Number", "desc" : "The number of records to display per page (defaults to 20)", - "memberOf" : "Roo.PagingToolbar", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataSource", "type" : "Roo.data.Store", "desc" : "The underlying data store providing the paged data", - "memberOf" : "Roo.PagingToolbar", - "optvals" : [] + "memberOf" : "" }, { "name" : "container", "type" : "String/HTMLElement/Element", "desc" : "container The id or element that will contain the toolbar", - "memberOf" : "Roo.PagingToolbar", - "optvals" : [] + "memberOf" : "" }, { "name" : "emptyMsg", "type" : "String", "desc" : "The message to display when no records are found (defaults to \"No data to display\")", - "memberOf" : "Roo.PagingToolbar", - "optvals" : [] + "memberOf" : "" }, { "name" : "items", "type" : "Array", "desc" : "array of button configs or elements to add (will be converted to a MixedCollection)", - "memberOf" : "Roo.Toolbar", - "optvals" : [] + "memberOf" : "Roo.Toolbar" }, { "name" : "displayInfo", "type" : "Boolean", "desc" : "True to display the displayMsg (defaults to false)", - "memberOf" : "Roo.PagingToolbar", - "optvals" : [] + "memberOf" : "" }, { "name" : "displayMsg", "type" : "String", "desc" : "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")", - "memberOf" : "Roo.PagingToolbar", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "bind", + "type" : "function", "desc" : "Binds the paging toolbar to the specified {@link Roo.data.Store}", + "sig" : "(store)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.PagingToolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "store", @@ -103,15 +102,20 @@ }, { "name" : "unbind", + "type" : "function", "desc" : "Unbinds the paging toolbar from the specified {@link Roo.data.Store}", + "sig" : "(store)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.PagingToolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "store", @@ -124,15 +128,20 @@ }, { "name" : "addDom", + "type" : "function", "desc" : "Adds a new element to the toolbar from the passed {@link Roo.DomHelper} config.", + "sig" : "(config)", + "static" : false, + "memberOf" : "Roo.Toolbar", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -151,15 +160,20 @@ }, { "name" : "addElement", + "type" : "function", "desc" : "Adds any standard HTML element to the toolbar", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.Toolbar", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -178,15 +192,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the Element for this toolbar.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -198,29 +217,39 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide the toolbar", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "addSeparator", + "type" : "function", "desc" : "Adds a separator", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -232,29 +261,39 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show the toolbar", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "addFill", + "type" : "function", "desc" : "Adds a fill element that forces subsequent additions to the right side of the toolbar", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -266,15 +305,20 @@ }, { "name" : "addSpacer", + "type" : "function", "desc" : "Adds a spacer element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -286,15 +330,20 @@ }, { "name" : "add", + "type" : "function", "desc" : "Adds element(s) to the toolbar -- this function takes a variable number of \narguments of mixed type and adds them to the toolbar.", + "sig" : "(arg1, arg2)", + "static" : false, + "memberOf" : "Roo.Toolbar", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "arg1", @@ -313,15 +362,20 @@ }, { "name" : "addField", + "type" : "function", "desc" : "Adds a dynamically rendered Roo.form field (TextField, ComboBox, etc).\nNote: the field should not have been rendered yet. For a field that has already been\nrendered, use {@link #addElement}.", + "sig" : "(field)", + "static" : false, + "memberOf" : "Roo.Toolbar", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "field", @@ -340,15 +394,20 @@ }, { "name" : "addText", + "type" : "function", "desc" : "Adds text to the toolbar", + "sig" : "(text)", + "static" : false, + "memberOf" : "Roo.Toolbar", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "text", @@ -367,15 +426,20 @@ }, { "name" : "addItem", + "type" : "function", "desc" : "Adds any Toolbar.Item or subclass", + "sig" : "(item)", + "static" : false, + "memberOf" : "Roo.Toolbar", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "item", @@ -394,15 +458,20 @@ }, { "name" : "addButton", + "type" : "function", "desc" : "Adds a button (or buttons). See {@link Roo.Toolbar.Button} for more info on the config.", + "sig" : "(config)", + "static" : false, + "memberOf" : "Roo.Toolbar", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -421,15 +490,20 @@ }, { "name" : "insertButton", + "type" : "function", "desc" : "Inserts any {@link Roo.Toolbar.Item}/{@link Roo.Toolbar.Button} at the specified index.", + "sig" : "(index, item)", + "static" : false, + "memberOf" : "Roo.Toolbar", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -454,15 +528,20 @@ }, { "name" : "addxtype", + "type" : "function", "desc" : "Add an Xtype element", + "sig" : "(xtype)", + "static" : false, + "memberOf" : "Roo.Toolbar", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "xtype", diff --git a/docs/symbols/Roo.QuickTips.json b/docs/symbols/Roo.QuickTips.json index 37c050b74e..b9ab63b01a 100644 --- a/docs/symbols/Roo.QuickTips.json +++ b/docs/symbols/Roo.QuickTips.json @@ -12,153 +12,155 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "showDelay", "type" : "Number", "desc" : "Delay in milliseconds before the quick tip displays after the mouse enters the target element (defaults to 500)", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "" }, { "name" : "maxWidth", "type" : "Number", "desc" : "The maximum width of the quick tip (defaults to 300)", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "" }, { "name" : "Delay", "type" : "Number", "desc" : "in milliseconds before the quick tip hides when autoDismiss = true (defaults to 5000)", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "" }, { "name" : "text", "type" : "String", "desc" : "Body text to display (defaults to ''). This can be any valid HTML markup.", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "" }, { "name" : "hideOnClick", "type" : "Boolean", "desc" : "True to hide the quick tip if the user clicks anywhere in the document (defaults to true)", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "" }, { "name" : "minWidth", "type" : "Number", "desc" : "The minimum width of the quick tip (defaults to 40)", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "" }, { "name" : "hideDelay", "type" : "Number", "desc" : "Delay in milliseconds before the quick tip hides when autoHide = true (defaults to 200)", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "" }, { "name" : "title", "type" : "String", "desc" : "Title text to display (defaults to ''). This can be any valid HTML markup.", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the base quick tip element (defaults to '').", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "" }, { "name" : "width", "type" : "Number", "desc" : "Width in pixels of the quick tip (defaults to auto). Width will be ignored if it exceeds the bounds of\nminWidth or maxWidth.", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "" }, { "name" : "interceptTitles", "type" : "Boolean", "desc" : "True to automatically use the element's DOM title value if available (defaults to false)", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "" }, { "name" : "trackMouse", "type" : "Boolean", "desc" : "True to have the quick tip follow the mouse as it moves over the target element (defaults to false)", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "" }, { "name" : "True", "type" : "Boolean", "desc" : "to automatically hide the quick tip after a set period of time, regardless of the user's actions\n(defaults to true). Used in conjunction with autoDismissDelay.", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "" }, { "name" : "animate", "type" : "Boolean", "desc" : "True to turn on fade animation. Defaults to false (ClearType/scrollbar flicker issues in IE7).", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "" }, { "name" : "autoHide", "type" : "Boolean", "desc" : "True to automatically hide the quick tip after the mouse exits the target element (defaults to true).\nUsed in conjunction with hideDelay.", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "isEnabled", + "type" : "function", "desc" : "Returns true if the quick tip is enabled, else false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.QuickTips", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "disable", + "type" : "function", "desc" : "Disable this quick tip.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.QuickTips", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "unregister", + "type" : "function", "desc" : "Removes this quick tip from its element and destroys it.", + "sig" : "(el)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.QuickTips", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -171,43 +173,58 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this quick tip.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.QuickTips", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "init", + "type" : "function", "desc" : "Initialize and enable QuickTips for first use. This should be called once before the first attempt to access\nor display QuickTips in a page.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.QuickTips", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "register", + "type" : "function", "desc" : "Configures a new quick tip instance and assigns it to a target element. The following config options\nare supported:\n
\nProperty    Type                   Description\n----------  ---------------------  ------------------------------------------------------------------------\ntarget      Element/String/Array   An Element, id or array of ids that this quick tip should be tied to\n",
+      "sig" : "(config)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.QuickTips",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "config",
diff --git a/docs/symbols/Roo.ReaderLayout.json b/docs/symbols/Roo.ReaderLayout.json
index 8379d99a04..40ded00898 100644
--- a/docs/symbols/Roo.ReaderLayout.json
+++ b/docs/symbols/Roo.ReaderLayout.json
@@ -29,27 +29,63 @@
     }
   ],
   "returns" : [],
+  "throws" : "",
+  "requires" : "",
   "config" : [
+    {
+      "name" : "center",
+      "type" : "Roo.LayoutRegion",
+      "desc" : "",
+      "memberOf" : "Roo.BorderLayout"
+    },
     {
       "name" : "listeners",
       "type" : "Object",
       "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "east", + "type" : "Roo.LayoutRegion", + "desc" : "", + "memberOf" : "Roo.BorderLayout" + }, + { + "name" : "west", + "type" : "Roo.LayoutRegion", + "desc" : "", + "memberOf" : "Roo.BorderLayout" + }, + { + "name" : "north", + "type" : "Roo.LayoutRegion", + "desc" : "", + "memberOf" : "Roo.BorderLayout" + }, + { + "name" : "south", + "type" : "Roo.LayoutRegion", + "desc" : "", + "memberOf" : "Roo.BorderLayout" } ], "methods" : [ { "name" : "create", + "type" : "function", "desc" : "Shortcut for creating a new BorderLayout object and adding one or more ContentPanels to it in a single step, handling\nthe beginUpdate and endUpdate calls internally. The key to this method is the panels property that can be\nprovided with each region config, which allows you to add ContentPanel configs in addition to the region configs\nduring creation. The following code is equivalent to the constructor-based example at the beginning of this class:\n
\n// shorthand\nvar CP = Roo.ContentPanel;\n\nvar layout = Roo.BorderLayout.create({\n    north: {\n        initialSize: 25,\n        titlebar: false,\n        panels: [new CP(\"north\", \"North\")]\n    },\n    west: {\n        split:true,\n        initialSize: 200,\n        minSize: 175,\n        maxSize: 400,\n        titlebar: true,\n        collapsible: true,\n        panels: [new CP(\"west\", {title: \"West\"})]\n    },\n    east: {\n        split:true,\n        initialSize: 202,\n        minSize: 175,\n        maxSize: 400,\n        titlebar: true,\n        collapsible: true,\n        panels: [new CP(\"autoTabs\", {title: \"Auto Tabs\", closable: true})]\n    },\n    south: {\n        split:true,\n        initialSize: 100,\n        minSize: 100,\n        maxSize: 200,\n        titlebar: true,\n        collapsible: true,\n        panels: [new CP(\"south\", {title: \"South\", closable: true})]\n    },\n    center: {\n        titlebar: true,\n        autoScroll:true,\n        resizeTabs: true,\n        minTabWidth: 50,\n        preferredTabWidth: 150,\n        panels: [\n            new CP(\"center1\", {title: \"Close Me\", closable: true}),\n            new CP(\"center2\", {title: \"Center Panel\", closable: false})\n        ]\n    }\n}, document.body);\n\nlayout.getRegion(\"center\").showPanel(\"center1\");\n
", + "sig" : "(config, targetEl)", + "static" : true, + "memberOf" : "Roo.BorderLayout", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BorderLayout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -68,15 +104,20 @@ }, { "name" : "restoreState", + "type" : "function", "desc" : "Restores this layout's state using Roo.state.Manager or the state provided by the passed provider.", + "sig" : "(provider)", + "static" : false, + "memberOf" : "Roo.BorderLayout", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BorderLayout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "provider", @@ -89,15 +130,20 @@ }, { "name" : "addRegion", + "type" : "function", "desc" : "Creates and adds a new region if it doesn't already exist.", + "sig" : "(target, config)", + "static" : false, + "memberOf" : "Roo.BorderLayout", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BorderLayout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -122,15 +168,20 @@ }, { "name" : "showPanel", + "type" : "function", "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.", + "sig" : "(panelId)", + "static" : false, + "memberOf" : "Roo.BorderLayout", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BorderLayout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panelId", @@ -149,15 +200,20 @@ }, { "name" : "batchAdd", + "type" : "function", "desc" : "Adds a batch of multiple ContentPanels dynamically by passing a special regions config object. This config\nobject should contain properties for each region to add ContentPanels to, and each property's value should be\na valid ContentPanel config object. Example:\n
\n// Create the main layout\nvar layout = new Roo.BorderLayout('main-ct', {\n    west: {\n        split:true,\n        minSize: 175,\n        titlebar: true\n    },\n    center: {\n        title:'Components'\n    }\n}, 'main-ct');\n\n// Create and add multiple ContentPanels at once via configs\nlayout.batchAdd({\n   west: {\n       id: 'source-files',\n       autoCreate:true,\n       title:'Ext Source Files',\n       autoScroll:true,\n       fitToFrame:true\n   },\n   center : {\n       el: cview,\n       autoScroll:true,\n       fitToFrame:true,\n       toolbar: tb,\n       resizeEl:'cbody'\n   }\n});\n
", + "sig" : "(regions)", + "static" : false, + "memberOf" : "Roo.BorderLayout", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BorderLayout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "regions", @@ -170,15 +226,20 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Remove a ContentPanel (or subclass) to this layout.", + "sig" : "(target, panel)", + "static" : false, + "memberOf" : "Roo.BorderLayout", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BorderLayout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -203,15 +264,20 @@ }, { "name" : "findPanel", + "type" : "function", "desc" : "Searches all regions for a panel with the specified id", + "sig" : "(panelId)", + "static" : false, + "memberOf" : "Roo.BorderLayout", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BorderLayout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panelId", @@ -230,29 +296,39 @@ }, { "name" : "layout", + "type" : "function", "desc" : "Performs a layout update.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BorderLayout", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BorderLayout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "addxtype", + "type" : "function", "desc" : "Adds a xtype elements to the layout.\n
\n\nlayout.addxtype({\n       xtype : 'ContentPanel',\n       region: 'west',\n       items: [ .... ]\n   }\n);\n\nlayout.addxtype({\n        xtype : 'NestedLayoutPanel',\n        region: 'west',\n        layout: {\n           center: { },\n           west: { }   \n        },\n        items : [ ... list of content panels or nested layout panels.. ]\n   }\n);\n
", + "sig" : "(cfg)", + "static" : false, + "memberOf" : "Roo.BorderLayout", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BorderLayout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cfg", @@ -265,15 +341,20 @@ }, { "name" : "add", + "type" : "function", "desc" : "Adds a ContentPanel (or subclass) to this layout.", + "sig" : "(target, panel)", + "static" : false, + "memberOf" : "Roo.BorderLayout", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BorderLayout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -298,15 +379,20 @@ }, { "name" : "getRegion", + "type" : "function", "desc" : "Returns the specified region.", + "sig" : "(target)", + "static" : false, + "memberOf" : "Roo.LayoutManager", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -325,29 +411,39 @@ }, { "name" : "beginUpdate", + "type" : "function", "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutManager", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isUpdating", + "type" : "function", "desc" : "Returns true if this layout is currently being updated", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutManager", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -359,15 +455,20 @@ }, { "name" : "getViewSize", + "type" : "function", "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutManager", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -379,15 +480,20 @@ }, { "name" : "endUpdate", + "type" : "function", "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout", + "sig" : "(noLayout)", + "static" : false, + "memberOf" : "Roo.LayoutManager", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "noLayout", @@ -400,15 +506,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the Element this layout is bound to.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutManager", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -420,29 +531,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -473,15 +594,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -506,15 +632,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -527,15 +658,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -548,15 +684,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -581,15 +722,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -614,15 +760,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -641,15 +792,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -674,15 +830,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -715,7 +876,9 @@ "events" : [ { "name" : "layout", + "type" : "function", "desc" : "Fires when a layout is performed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", @@ -733,7 +896,9 @@ }, { "name" : "regionexpanded", + "type" : "function", "desc" : "Fires when a region is expanded.", + "sig" : "function (region)\n{\n\n}", "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", @@ -751,7 +916,9 @@ }, { "name" : "regionresized", + "type" : "function", "desc" : "Fires when the user resizes a region.", + "sig" : "function (region, newSize)\n{\n\n}", "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", @@ -775,7 +942,9 @@ }, { "name" : "regioncollapsed", + "type" : "function", "desc" : "Fires when a region is collapsed.", + "sig" : "function (region)\n{\n\n}", "memberOf" : "Roo.LayoutManager", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.Resizable.json b/docs/symbols/Roo.Resizable.json index 054573714b..4a8818065f 100644 --- a/docs/symbols/Roo.Resizable.json +++ b/docs/symbols/Roo.Resizable.json @@ -27,216 +27,195 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "easing", "type" : "String", "desc" : "Animation easing if animate = true (defaults to 'easingOutStrong')", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "maxWidth", "type" : "Number", "desc" : "The maximum width for the element (defaults to 10000)", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "minWidth", "type" : "Number", "desc" : "The minimum width for the element (defaults to 5)", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "dynamic", "type" : "Boolean", "desc" : "True to resize the element while dragging instead of using a proxy (defaults to false)", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "pinned", "type" : "Boolean", "desc" : "True to ensure that the resize handles are always visible, false to display them only when the\nuser mouses over the resizable borders. This is only applied at config time. (defaults to false)", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "enabled", "type" : "Boolean", "desc" : "False to disable resizing (defaults to true)", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "handles", "type" : "String", "desc" : "String consisting of the resize handles to display (defaults to undefined)", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "preserveRatio", "type" : "Boolean", "desc" : "True to preserve the original ratio between height and width during resize (defaults to false)", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "minHeight", "type" : "Number", "desc" : "The minimum height for the element (defaults to 5)", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "maxHeight", "type" : "Number", "desc" : "The maximum height for the element (defaults to 10000)", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "widthIncrement", "type" : "Number", "desc" : "The increment to snap the width resize in pixels (dynamic must be true, defaults to 0)", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "resizeChild", "type" : "Boolean/String/Element", "desc" : "True to resize the first child, or id/element to resize (defaults to false)", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "width", "type" : "Number", "desc" : "The width of the element in pixels (defaults to null)", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "transparent", "type" : "Boolean", "desc" : "True for transparent handles. This is only applied at config time. (defaults to false)", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "minX", "type" : "Number", "desc" : "The minimum allowed page X for the element (only used for west resizing, defaults to 0)", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "constrainTo", "type" : "String/HTMLElement/Element", "desc" : "Constrain the resize to a particular element", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "disableTrackOver", "type" : "Boolean", "desc" : "True to disable mouse tracking. This is only applied at config time. (defaults to false)", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "minY", "type" : "Number", "desc" : "The minimum allowed page Y for the element (only used for north resizing, defaults to 0)", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "adjustments", "type" : "Array/String", "desc" : "String \"auto\" or an array [width, height] with values to be added to the\nresize operation's new size (defaults to [0, 0])", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "wrap", "type" : "Boolean", "desc" : "True to wrap an element with a div if needed (required for textareas and images, defaults to false)", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "height", "type" : "Number", "desc" : "The height of the element in pixels (defaults to null)", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "duration", "type" : "Number", "desc" : "Animation duration if animate = true (defaults to .35)", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "animate", "type" : "Boolean", "desc" : "True to animate the resize (not compatible with dynamic sizing, defaults to false)", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "multiDirectional", "type" : "Boolean", "desc" : "Deprecated. The old style of adding multi-direction resize handles, deprecated\nin favor of the handles config option (defaults to false)", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "heightIncrement", "type" : "Number", "desc" : "The increment to snap the height resize in pixels (dynamic must be true, defaults to 0)", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "draggable", "type" : "Boolean", "desc" : "Convenience to initialize drag drop (defaults to false)", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" }, { "name" : "resizeRegion", "type" : "Roo.lib.Region", "desc" : "Constrain the resize to a particular region", - "memberOf" : "Roo.Resizable", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "getEl", + "type" : "function", "desc" : "Returns the element this component is bound to.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Resizable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -248,15 +227,20 @@ }, { "name" : "getResizeChild", + "type" : "function", "desc" : "Returns the resizeChild element (or null).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Resizable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -268,15 +252,20 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Destroys this resizable. If the element was wrapped and\nremoveEl is not true then the element remains.", + "sig" : "(removeEl)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Resizable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "removeEl", @@ -289,15 +278,20 @@ }, { "name" : "resizeTo", + "type" : "function", "desc" : "Perform a manual resize", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Resizable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -316,29 +310,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -369,15 +373,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -402,15 +411,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -423,15 +437,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -444,15 +463,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -477,15 +501,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -510,15 +539,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -537,15 +571,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -570,15 +609,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -611,8 +655,10 @@ "events" : [ { "name" : "resize", + "type" : "function", "desc" : "Fired after a resize.", - "memberOf" : "Roo.Resizable", + "sig" : "function (_self, width, height, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -647,8 +693,10 @@ }, { "name" : "resizing", + "type" : "function", "desc" : "Fired a resizing.", - "memberOf" : "Roo.Resizable", + "sig" : "function (_self, x, y, w, h, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -695,8 +743,10 @@ }, { "name" : "beforeresize", + "type" : "function", "desc" : "Fired before resize is allowed. Set enabled to false to cancel resize.", - "memberOf" : "Roo.Resizable", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.Shadow.json b/docs/symbols/Roo.Shadow.json index de7e8d0bf1..69bdc5571f 100644 --- a/docs/symbols/Roo.Shadow.json +++ b/docs/symbols/Roo.Shadow.json @@ -19,34 +19,39 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "mode", "type" : "String", "desc" : "The shadow display mode. Supports the following options:
\nsides: Shadow displays on both sides and bottom only
\nframe: Shadow displays equally on all four sides
\ndrop: Traditional bottom-right drop shadow (default)", - "memberOf" : "Roo.Shadow", - "optvals" : [] + "memberOf" : "" }, { "name" : "offset", "type" : "String", "desc" : "The number of pixels to offset the shadow from the element (defaults to 4)", - "memberOf" : "Roo.Shadow", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "setZIndex", + "type" : "function", "desc" : "Adjust the z-index of this shadow", + "sig" : "(zindex)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Shadow", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "zindex", @@ -59,43 +64,58 @@ }, { "name" : "isVisible", + "type" : "function", "desc" : "Returns true if the shadow is visible, else false", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Shadow", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "hide", + "type" : "function", "desc" : "Hides this shadow", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Shadow", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "show", + "type" : "function", "desc" : "Displays the shadow under the target element", + "sig" : "(targetEl)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Shadow", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "targetEl", @@ -108,15 +128,20 @@ }, { "name" : "realign", + "type" : "function", "desc" : "Direct alignment when values are already available. Show must be called at least once before\ncalling this method to ensure it is initialized.", + "sig" : "(left, top, width, height)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Shadow", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", diff --git a/docs/symbols/Roo.SplitBar.AbsoluteLayoutAdapter.json b/docs/symbols/Roo.SplitBar.AbsoluteLayoutAdapter.json index 127f62dead..9a6893f746 100644 --- a/docs/symbols/Roo.SplitBar.AbsoluteLayoutAdapter.json +++ b/docs/symbols/Roo.SplitBar.AbsoluteLayoutAdapter.json @@ -21,19 +21,26 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "setElementSize", + "type" : "function", "desc" : "Called after drag operations to set the size of the resizing element.", + "sig" : "(s, newSize, onComplete)", + "static" : false, + "memberOf" : "Roo.SplitBar.BasicLayoutAdapter", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.SplitBar.BasicLayoutAdapter", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "s", @@ -58,15 +65,20 @@ }, { "name" : "getElementSize", + "type" : "function", "desc" : "Called before drag operations to get the current size of the resizing element.", + "sig" : "(s)", + "static" : false, + "memberOf" : "Roo.SplitBar.BasicLayoutAdapter", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.SplitBar.BasicLayoutAdapter", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "s", diff --git a/docs/symbols/Roo.SplitBar.BasicLayoutAdapter.json b/docs/symbols/Roo.SplitBar.BasicLayoutAdapter.json index 6c3adc7faa..9c2b9340dc 100644 --- a/docs/symbols/Roo.SplitBar.BasicLayoutAdapter.json +++ b/docs/symbols/Roo.SplitBar.BasicLayoutAdapter.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "setElementSize", + "type" : "function", "desc" : "Called after drag operations to set the size of the resizing element.", + "sig" : "(s, newSize, onComplete)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.SplitBar.BasicLayoutAdapter", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "s", @@ -49,15 +56,20 @@ }, { "name" : "getElementSize", + "type" : "function", "desc" : "Called before drag operations to get the current size of the resizing element.", + "sig" : "(s)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.SplitBar.BasicLayoutAdapter", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "s", diff --git a/docs/symbols/Roo.SplitBar.json b/docs/symbols/Roo.SplitBar.json index 9122e1dc19..bb9377ac4b 100644 --- a/docs/symbols/Roo.SplitBar.json +++ b/docs/symbols/Roo.SplitBar.json @@ -39,27 +39,33 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" } ], "methods" : [ { "name" : "getAdapter", + "type" : "function", "desc" : "Get the adapter this SplitBar uses", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.SplitBar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -71,15 +77,20 @@ }, { "name" : "setMaximumSize", + "type" : "function", "desc" : "Sets the maximum size for the resizing element", + "sig" : "(maxSize)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.SplitBar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "maxSize", @@ -92,15 +103,20 @@ }, { "name" : "setCurrentSize", + "type" : "function", "desc" : "Sets the initialize size for the resizing element", + "sig" : "(size)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.SplitBar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "size", @@ -113,15 +129,20 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Destroy this splitbar.", + "sig" : "(removeEl)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.SplitBar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "removeEl", @@ -134,15 +155,20 @@ }, { "name" : "setMinimumSize", + "type" : "function", "desc" : "Sets the minimum size for the resizing element", + "sig" : "(minSize)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.SplitBar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "minSize", @@ -155,15 +181,20 @@ }, { "name" : "getMinimumSize", + "type" : "function", "desc" : "Gets the minimum size for the resizing element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.SplitBar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -175,15 +206,20 @@ }, { "name" : "getMaximumSize", + "type" : "function", "desc" : "Gets the maximum size for the resizing element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.SplitBar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -195,15 +231,20 @@ }, { "name" : "setAdapter", + "type" : "function", "desc" : "Set the adapter this SplitBar uses", + "sig" : "(adapter)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.SplitBar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adapter", @@ -216,29 +257,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -269,15 +320,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -302,15 +358,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -323,15 +384,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -344,15 +410,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -377,15 +448,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -410,15 +486,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -437,15 +518,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -470,15 +556,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -511,8 +602,10 @@ "events" : [ { "name" : "resize", + "type" : "function", "desc" : "Fires when the splitter is moved (alias for {@link #event-moved})", - "memberOf" : "Roo.SplitBar", + "sig" : "function (_self, newSize)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -535,8 +628,10 @@ }, { "name" : "beforeresize", + "type" : "function", "desc" : "Fires before the splitter is dragged", - "memberOf" : "Roo.SplitBar", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -553,8 +648,10 @@ }, { "name" : "moved", + "type" : "function", "desc" : "Fires when the splitter is moved", - "memberOf" : "Roo.SplitBar", + "sig" : "function (_self, newSize)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.SplitButton.json b/docs/symbols/Roo.SplitButton.json index 5707477def..fed9e3a890 100644 --- a/docs/symbols/Roo.SplitButton.json +++ b/docs/symbols/Roo.SplitButton.json @@ -28,202 +28,183 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "String/Object", "desc" : "The tooltip for the button - can be a string or QuickTips config object", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "text", "type" : "String", "desc" : "The button text", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "renderTo", "type" : "String/HTMLElement/Element", "desc" : "The element to append the button to", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "hidden", "type" : "Boolean", "desc" : "True to start hidden (defaults to false)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "toggleGroup", "type" : "String", "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "handleMouseEvents", "type" : "Boolean", "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "menu", - "type" : "Mixed", + "type" : "Roo.menu.Menu", "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "enableToggle", "type" : "Boolean", "desc" : "True to enable pressed/not pressed toggling (defaults to false)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "arrowHandler", "type" : "Function", "desc" : "A function called when the arrow button is clicked (can be used instead of click event)", - "memberOf" : "Roo.SplitButton", - "optvals" : [] + "memberOf" : "" }, { "name" : "handler", "type" : "Function", "desc" : "A function called when the button is clicked (can be used instead of click event)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "scope", "type" : "Object", "desc" : "The scope of the handler", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "minWidth", "type" : "Number", "desc" : "The minimum width for this button (used to give a set of buttons a common width)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to start disabled (defaults to false)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "pressed", "type" : "Boolean", "desc" : "True to start pressed (only if enableToggle = true)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "template", "type" : "Roo.Template", "desc" : "(Optional)\nAn {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the button's main element.", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The DOM tabIndex for this button (defaults to undefined)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "iconCls", "type" : "String", "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "menuAlign", "type" : "String", "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "icon", "type" : "String", "desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "tooltipType", "type" : "String", "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "arrowTooltip", "type" : "String", "desc" : "The title attribute of the arrow", - "memberOf" : "Roo.SplitButton", - "optvals" : [] + "memberOf" : "" }, { "name" : "clickEvent", "type" : "String", "desc" : "The type of event to map to the button's event handler (defaults to 'click')", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "repeat", "type" : "Boolean/Object", "desc" : "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "type", "type" : "String", "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" } ], "methods" : [ { "name" : "setArrowHandler", + "type" : "function", "desc" : "Sets this button's arrow click handler", + "sig" : "(handler, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.SplitButton", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "handler", @@ -242,29 +223,39 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Focus the button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.SplitButton", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setHandler", + "type" : "function", "desc" : "Sets this button's click handler", + "sig" : "(handler, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.SplitButton", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "handler", @@ -283,57 +274,77 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "disable", + "type" : "function", "desc" : "Disable this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "enable", + "type" : "function", "desc" : "Enable this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the button's underlying element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -345,15 +356,20 @@ }, { "name" : "setDisabled", + "type" : "function", "desc" : "Convenience function for boolean enable/disable", + "sig" : "(enabled)", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "enabled", @@ -366,15 +382,20 @@ }, { "name" : "setVisible", + "type" : "function", "desc" : "Convenience function for boolean show/hide", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -387,29 +408,39 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Destroys this Button and removes any listeners.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getText", + "type" : "function", "desc" : "Gets the text for this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -421,15 +452,20 @@ }, { "name" : "setText", + "type" : "function", "desc" : "Sets this button's text", + "sig" : "(text)", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "text", @@ -442,15 +478,20 @@ }, { "name" : "toggle", + "type" : "function", "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.", + "sig" : "(state)", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "state", @@ -463,43 +504,58 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -530,15 +586,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -563,15 +624,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -584,15 +650,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -605,15 +676,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -638,15 +714,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -671,15 +752,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -698,15 +784,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -731,15 +822,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -772,8 +868,10 @@ "events" : [ { "name" : "arrowclick", + "type" : "function", "desc" : "Fires when this button's arrow is clicked", - "memberOf" : "Roo.SplitButton", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -796,7 +894,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires when the button is rendered", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", @@ -814,7 +914,9 @@ }, { "name" : "click", + "type" : "function", "desc" : "Fires when this button is clicked", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", @@ -838,7 +940,9 @@ }, { "name" : "mouseover", + "type" : "function", "desc" : "Fires when the mouse hovers over the button", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", @@ -862,7 +966,9 @@ }, { "name" : "toggle", + "type" : "function", "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)", + "sig" : "function (_self, pressed)\n{\n\n}", "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", @@ -886,7 +992,9 @@ }, { "name" : "mouseout", + "type" : "function", "desc" : "Fires when the mouse exits the button", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.SplitLayoutRegion.json b/docs/symbols/Roo.SplitLayoutRegion.json index 954340b33d..0a8ff247a9 100644 --- a/docs/symbols/Roo.SplitLayoutRegion.json +++ b/docs/symbols/Roo.SplitLayoutRegion.json @@ -16,219 +16,195 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "cmargins", "type" : "Object", "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "alwaysShowTabs", "type" : "Boolean", "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "margins", "type" : "Object", "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "preferredTabWidth", "type" : "Number", "desc" : "The preferred tab width (defaults to 150)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "disableTabTips", "type" : "Boolean", "desc" : "True to disable tab tooltips", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "collapsible", "type" : "Boolean", "desc" : "False to disable collapsing (defaults to true)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "collapsedTitle", "type" : "String", "desc" : "Optional string message to display in the collapsed block of a north or south region", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "autoScroll", "type" : "Boolean", "desc" : "True to enable overflow scrolling (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "hidden", "type" : "Boolean", "desc" : "True to start the region hidden (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "toolbar", "type" : "Boolean", "desc" : "xtype configuration for a toolbar - shows on right of tabbar", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "title", "type" : "String", "desc" : "The title for the region (overrides panel titles)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "hideWhenEmpty", "type" : "Boolean", "desc" : "True to hide the region when it has no panels", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "collapsed", "type" : "Boolean", "desc" : "True to set the initial display to collapsed (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "hideTabs", "type" : "Boolean", "desc" : "True to hide the tab strip (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "resizeTabs", "type" : "Boolean", "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "tabPosition", "type" : "String", "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [ - "top", - "bottom" - ] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "width", "type" : "Number", "desc" : "For East/West panels", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "floatable", "type" : "Boolean", "desc" : "False to disable floating (defaults to true)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "minTabWidth", "type" : "Number", "desc" : "The minimum tab width (defaults to 40)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "split", "type" : "Boolean", "desc" : "To show the splitter", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "titlebar", "type" : "Boolean", "desc" : "True to display a title bar (defaults to true)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "preservePanels", "type" : "Boolean", "desc" : "True to preserve removed panels so they can be readded later (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "closeOnTab", "type" : "Boolean", "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "height", "type" : "Number", "desc" : "For North/South panels", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "animate", "type" : "Boolean", "desc" : "True to animate expand/collapse (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "autoHide", "type" : "Boolean", "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "showPin", "type" : "Boolean", "desc" : "True to show a pin button", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" } ], "methods" : [ { "name" : "getSplitBar", + "type" : "function", "desc" : "Returns the {@link Roo.SplitBar} for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.SplitLayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -240,15 +216,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the container element for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -260,15 +241,20 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.", + "sig" : "(panel, preservePanel)", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -293,15 +279,20 @@ }, { "name" : "getActivePanel", + "type" : "function", "desc" : "Get the active panel for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -313,15 +304,20 @@ }, { "name" : "collapse", + "type" : "function", "desc" : "Collapses this region.", + "sig" : "(skipAnim)", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "skipAnim", @@ -334,15 +330,20 @@ }, { "name" : "unhidePanel", + "type" : "function", "desc" : "Unhides the tab for a previously hidden panel.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -355,15 +356,20 @@ }, { "name" : "setCollapsedTitle", + "type" : "function", "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)", + "sig" : "(title)", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "title", @@ -376,15 +382,20 @@ }, { "name" : "getTabs", + "type" : "function", "desc" : "Returns the TabPanel component used by this region", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -396,15 +407,20 @@ }, { "name" : "expand", + "type" : "function", "desc" : "Expands this region if it was previously collapsed.", + "sig" : "(e, skipAnim)", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -423,15 +439,20 @@ }, { "name" : "isVisible", + "type" : "function", "desc" : "Returns true if this region is currently visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -443,15 +464,20 @@ }, { "name" : "showPanel", + "type" : "function", "desc" : "Shows the specified panel.", + "sig" : "(panelId)", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panelId", @@ -470,43 +496,58 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hides this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "show", + "type" : "function", "desc" : "Shows this region if it was previously hidden.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "add", + "type" : "function", "desc" : "Adds the passed ContentPanel(s) to this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -525,15 +566,20 @@ }, { "name" : "hidePanel", + "type" : "function", "desc" : "Hides the tab for the specified panel.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -546,15 +592,20 @@ }, { "name" : "hasPanel", + "type" : "function", "desc" : "Returns true if the panel is in this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.BasicLayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -573,15 +624,20 @@ }, { "name" : "resizeTo", + "type" : "function", "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.", + "sig" : "(newSize)", + "static" : false, + "memberOf" : "Roo.BasicLayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "newSize", @@ -594,15 +650,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Returns this regions position (north/south/east/west/center).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BasicLayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -614,15 +675,20 @@ }, { "name" : "getPanel", + "type" : "function", "desc" : "Returns the panel specified or null if it's not in this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.BasicLayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -641,29 +707,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -694,15 +770,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -727,15 +808,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -748,15 +834,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -769,15 +860,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -802,15 +898,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -835,15 +936,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -862,15 +968,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -895,15 +1006,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -936,7 +1052,9 @@ "events" : [ { "name" : "paneladded", + "type" : "function", "desc" : "Fires when a panel is added.", + "sig" : "function (_self, panel)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -960,7 +1078,9 @@ }, { "name" : "invalidated", + "type" : "function", "desc" : "Fires when the layout for this region is changed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -978,7 +1098,9 @@ }, { "name" : "expanded", + "type" : "function", "desc" : "Fires when this region is expanded.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -996,7 +1118,9 @@ }, { "name" : "beforeremove", + "type" : "function", "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.", + "sig" : "function (_self, panel, e)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1026,7 +1150,9 @@ }, { "name" : "collapsed", + "type" : "function", "desc" : "Fires when this region is collapsed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1044,7 +1170,9 @@ }, { "name" : "panelremoved", + "type" : "function", "desc" : "Fires when a panel is removed.", + "sig" : "function (_self, panel)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1068,7 +1196,9 @@ }, { "name" : "beforecollapse", + "type" : "function", "desc" : "Fires when this region before collapse.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1086,7 +1216,9 @@ }, { "name" : "slidehide", + "type" : "function", "desc" : "Fires when this region slides out of view.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1104,7 +1236,9 @@ }, { "name" : "visibilitychange", + "type" : "function", "desc" : "Fires when this region is shown or hidden", + "sig" : "function (_self, visibility)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1128,7 +1262,9 @@ }, { "name" : "slideshow", + "type" : "function", "desc" : "Fires when this region is slid into view.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1146,7 +1282,9 @@ }, { "name" : "panelactivated", + "type" : "function", "desc" : "Fires when a panel is activated.", + "sig" : "function (_self, panel)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1170,7 +1308,9 @@ }, { "name" : "resized", + "type" : "function", "desc" : "Fires when the user resizes this region.", + "sig" : "function (_self, newSize)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.TabPanel.json b/docs/symbols/Roo.TabPanel.json index 2ef02fcc13..c404638e64 100644 --- a/docs/symbols/Roo.TabPanel.json +++ b/docs/symbols/Roo.TabPanel.json @@ -27,27 +27,33 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" } ], "methods" : [ { "name" : "getActiveTab", + "type" : "function", "desc" : "Gets the active {@link Roo.TabPanelItem}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -59,29 +65,39 @@ }, { "name" : "beginUpdate", + "type" : "function", "desc" : "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "unhideTab", + "type" : "function", "desc" : "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index.", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -94,15 +110,20 @@ }, { "name" : "enableTab", + "type" : "function", "desc" : "Enables a {@link Roo.TabPanelItem} that is disabled.", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -115,15 +136,20 @@ }, { "name" : "setTabWidth", + "type" : "function", "desc" : "Resizes all the tabs to the passed width", + "sig" : "(The)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "The", @@ -136,29 +162,39 @@ }, { "name" : "endUpdate", + "type" : "function", "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "addTab", + "type" : "function", "desc" : "Creates a new {@link Roo.TabPanelItem} by looking for an existing element with the provided id -- if it's not found it creates one.", + "sig" : "(id, text, content, closable)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -195,15 +231,20 @@ }, { "name" : "disableTab", + "type" : "function", "desc" : "Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored.", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -216,15 +257,20 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Destroys this TabPanel", + "sig" : "(removeEl)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "removeEl", @@ -237,15 +283,20 @@ }, { "name" : "getTab", + "type" : "function", "desc" : "Returns the {@link Roo.TabPanelItem} with the specified id/index", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -264,15 +315,20 @@ }, { "name" : "getCount", + "type" : "function", "desc" : "Returns the number of tabs in this TabPanel.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -284,29 +340,39 @@ }, { "name" : "autoSizeTabs", + "type" : "function", "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "removeTab", + "type" : "function", "desc" : "Removes a {@link Roo.TabPanelItem}.", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -319,15 +385,20 @@ }, { "name" : "activate", + "type" : "function", "desc" : "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated.", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -346,15 +417,20 @@ }, { "name" : "syncHeight", + "type" : "function", "desc" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling", + "sig" : "(targetHeight)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "targetHeight", @@ -367,15 +443,20 @@ }, { "name" : "addTabItem", + "type" : "function", "desc" : "Adds an existing {@link Roo.TabPanelItem}.", + "sig" : "(item)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "item", @@ -388,15 +469,20 @@ }, { "name" : "hideTab", + "type" : "function", "desc" : "Hides the {@link Roo.TabPanelItem} with the specified id/index", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -409,29 +495,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -462,15 +558,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -495,15 +596,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -516,15 +622,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -537,15 +648,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -570,15 +686,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -603,15 +724,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -630,15 +756,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -663,15 +794,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -704,8 +840,10 @@ "events" : [ { "name" : "beforetabchange", + "type" : "function", "desc" : "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change", - "memberOf" : "Roo.TabPanel", + "sig" : "function (_self, e, tab)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -734,8 +872,10 @@ }, { "name" : "tabchange", + "type" : "function", "desc" : "Fires when the active tab changes", - "memberOf" : "Roo.TabPanel", + "sig" : "function (_self, activePanel)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.TabPanelItem.json b/docs/symbols/Roo.TabPanelItem.json index 513b59218b..af8d6ccd97 100644 --- a/docs/symbols/Roo.TabPanelItem.json +++ b/docs/symbols/Roo.TabPanelItem.json @@ -39,27 +39,33 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" } ], "methods" : [ { "name" : "setUrl", + "type" : "function", "desc" : "Set a URL to be used to load the content for this TabPanelItem.", + "sig" : "(url, params, loadOnce)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanelItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "url", @@ -90,15 +96,20 @@ }, { "name" : "getText", + "type" : "function", "desc" : "Returns the text for this tab", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanelItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -110,15 +121,20 @@ }, { "name" : "isHidden", + "type" : "function", "desc" : "Returns true if this tab is \"hidden\"", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanelItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -130,15 +146,20 @@ }, { "name" : "setText", + "type" : "function", "desc" : "Sets the text for the tab (Note: this also sets the tooltip text)", + "sig" : "(text)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanelItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "text", @@ -151,29 +172,39 @@ }, { "name" : "activate", + "type" : "function", "desc" : "Activates this TabPanelItem -- this does deactivate the currently active TabPanelItem.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanelItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isActive", + "type" : "function", "desc" : "Returns true if this tab is the active tab.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanelItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -185,15 +216,20 @@ }, { "name" : "setContent", + "type" : "function", "desc" : "Sets the content for this TabPanelItem.", + "sig" : "(content, loadScripts)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanelItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "content", @@ -212,29 +248,39 @@ }, { "name" : "refresh", + "type" : "function", "desc" : "Forces a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the setUrl method has not been called.\n This does not activate the panel, just updates its content.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanelItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setHidden", + "type" : "function", "desc" : "Show or hide the tab", + "sig" : "(hidden)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanelItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "hidden", @@ -247,15 +293,20 @@ }, { "name" : "setTooltip", + "type" : "function", "desc" : "Set the tooltip for the tab.", + "sig" : "(tooltip)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanelItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "tooltip", @@ -268,29 +319,39 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enables this TabPanelItem if it was previously disabled.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanelItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getUpdateManager", + "type" : "function", "desc" : "Gets the {@link Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanelItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -302,71 +363,96 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanelItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "hide", + "type" : "function", "desc" : "Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanelItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "show", + "type" : "function", "desc" : "Shows this TabPanelItem -- this does not deactivate the currently active TabPanelItem.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.TabPanelItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -397,15 +483,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -430,15 +521,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -451,15 +547,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -472,15 +573,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -505,15 +611,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -538,15 +649,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -565,15 +681,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -598,15 +719,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -639,8 +765,10 @@ "events" : [ { "name" : "beforeclose", + "type" : "function", "desc" : "Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true).", - "memberOf" : "Roo.TabPanelItem", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -663,8 +791,10 @@ }, { "name" : "close", + "type" : "function", "desc" : "Fires when this tab is closed.", - "memberOf" : "Roo.TabPanelItem", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -681,8 +811,10 @@ }, { "name" : "activate", + "type" : "function", "desc" : "Fires when this tab becomes the active tab.", - "memberOf" : "Roo.TabPanelItem", + "sig" : "function (tabPanel, _self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -705,8 +837,10 @@ }, { "name" : "deactivate", + "type" : "function", "desc" : "Fires when this tab is no longer the active tab.", - "memberOf" : "Roo.TabPanelItem", + "sig" : "function (tabPanel, _self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.Template.json b/docs/symbols/Roo.Template.json index df4aa66409..1d00c695f3 100644 --- a/docs/symbols/Roo.Template.json +++ b/docs/symbols/Roo.Template.json @@ -19,41 +19,45 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "onLoad", "type" : "Function", "desc" : "Called after the template has been loaded and complied (usually from a remove source)", - "memberOf" : "Roo.Template", - "optvals" : [] + "memberOf" : "" }, { "name" : "html", "type" : "String", "desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")", - "memberOf" : "Roo.Template", - "optvals" : [] + "memberOf" : "" }, { "name" : "url", "type" : "String", "desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n it should be fixed so that template is observable...", - "memberOf" : "Roo.Template", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "insertFirst", + "type" : "function", "desc" : "Applies the supplied values to the template and inserts the new node(s) as the first child of el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -84,15 +88,20 @@ }, { "name" : "overwrite", + "type" : "function", "desc" : "Applies the supplied values to the template and overwrites the content of el with the new node(s).", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -123,15 +132,20 @@ }, { "name" : "insertBefore", + "type" : "function", "desc" : "Applies the supplied values to the template and inserts the new node(s) before el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -162,15 +176,20 @@ }, { "name" : "applyTemplate", + "type" : "function", "desc" : "Returns an HTML fragment of this template with the specified values applied.", + "sig" : "(values)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "values", @@ -189,15 +208,20 @@ }, { "name" : "compile", + "type" : "function", "desc" : "Compiles the template into an internal function, eliminating the RegEx overhead.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -209,15 +233,20 @@ }, { "name" : "set", + "type" : "function", "desc" : "Sets the HTML used as the template and optionally compiles it.", + "sig" : "(html, compile)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "html", @@ -242,15 +271,20 @@ }, { "name" : "from", + "type" : "function", "desc" : "Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML.", + "sig" : "(el)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -263,15 +297,20 @@ }, { "name" : "insertAfter", + "type" : "function", "desc" : "Applies the supplied values to the template and inserts the new node(s) after el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -302,15 +341,20 @@ }, { "name" : "append", + "type" : "function", "desc" : "Applies the supplied values to the template and appends the new node(s) to el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -341,15 +385,20 @@ }, { "name" : "apply", + "type" : "function", "desc" : "Alias for {@link #applyTemplate}", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] } diff --git a/docs/symbols/Roo.Toolbar.Button.json b/docs/symbols/Roo.Toolbar.Button.json index c32d884d34..66b5b36175 100644 --- a/docs/symbols/Roo.Toolbar.Button.json +++ b/docs/symbols/Roo.Toolbar.Button.json @@ -22,272 +22,285 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "String/Object", "desc" : "The tooltip for the button - can be a string or QuickTips config object", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "text", "type" : "String", "desc" : "The button text", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "renderTo", "type" : "String/HTMLElement/Element", "desc" : "The element to append the button to", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "hidden", "type" : "Boolean", "desc" : "True to start hidden (defaults to false)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "toggleGroup", "type" : "String", "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "handleMouseEvents", "type" : "Boolean", "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "menu", - "type" : "Mixed", + "type" : "Roo.menu.Menu", "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "enableToggle", "type" : "Boolean", "desc" : "True to enable pressed/not pressed toggling (defaults to false)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "handler", "type" : "Function", "desc" : "A function called when the button is clicked (can be used instead of click event)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "scope", "type" : "Object", "desc" : "The scope of the handler", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "minWidth", "type" : "Number", "desc" : "The minimum width for this button (used to give a set of buttons a common width)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to start disabled (defaults to false)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "pressed", "type" : "Boolean", "desc" : "True to start pressed (only if enableToggle = true)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "template", "type" : "Roo.Template", "desc" : "(Optional)\nAn {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the button's main element.", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The DOM tabIndex for this button (defaults to undefined)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "iconCls", "type" : "String", "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "menuAlign", "type" : "String", "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "icon", "type" : "String", "desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "tooltipType", "type" : "String", "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "clickEvent", "type" : "String", "desc" : "The type of event to map to the button's event handler (defaults to 'click')", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "repeat", "type" : "Boolean/Object", "desc" : "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "type", "type" : "String", "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" } ], "methods" : [ { "name" : "disable", + "type" : "function", "desc" : "Disables this item", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "enable", + "type" : "function", "desc" : "Enables this item", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "destroy", + "type" : "function", "desc" : "Removes and destroys this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "hide", + "type" : "function", "desc" : "Hides this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "show", + "type" : "function", "desc" : "Shows this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "focus", + "type" : "function", "desc" : "Focus the button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setHandler", + "type" : "function", "desc" : "Assigns this button's click handler", + "sig" : "(handler, scope)", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "handler", @@ -306,15 +319,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the button's underlying element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -326,15 +344,20 @@ }, { "name" : "setDisabled", + "type" : "function", "desc" : "Convenience function for boolean enable/disable", + "sig" : "(enabled)", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "enabled", @@ -347,15 +370,20 @@ }, { "name" : "setVisible", + "type" : "function", "desc" : "Convenience function for boolean show/hide", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -368,15 +396,20 @@ }, { "name" : "getText", + "type" : "function", "desc" : "Gets the text for this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -388,15 +421,20 @@ }, { "name" : "setText", + "type" : "function", "desc" : "Sets this button's text", + "sig" : "(text)", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "text", @@ -409,15 +447,20 @@ }, { "name" : "toggle", + "type" : "function", "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.", + "sig" : "(state)", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "state", @@ -430,29 +473,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -483,15 +536,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -516,15 +574,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -537,15 +600,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -558,15 +626,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -591,15 +664,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -624,15 +702,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -651,15 +734,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -684,15 +772,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -725,7 +818,9 @@ "events" : [ { "name" : "render", + "type" : "function", "desc" : "Fires when the button is rendered", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", @@ -743,7 +838,9 @@ }, { "name" : "click", + "type" : "function", "desc" : "Fires when this button is clicked", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", @@ -767,7 +864,9 @@ }, { "name" : "mouseover", + "type" : "function", "desc" : "Fires when the mouse hovers over the button", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", @@ -791,7 +890,9 @@ }, { "name" : "toggle", + "type" : "function", "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)", + "sig" : "function (_self, pressed)\n{\n\n}", "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", @@ -815,7 +916,9 @@ }, { "name" : "mouseout", + "type" : "function", "desc" : "Fires when the mouse exits the button", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.Toolbar.Fill.json b/docs/symbols/Roo.Toolbar.Fill.json index ccecd2453a..425698054d 100644 --- a/docs/symbols/Roo.Toolbar.Fill.json +++ b/docs/symbols/Roo.Toolbar.Fill.json @@ -15,75 +15,102 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "disable", + "type" : "function", "desc" : "Disables this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "hide", + "type" : "function", "desc" : "Hides this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "show", + "type" : "function", "desc" : "Shows this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getEl", + "type" : "function", "desc" : "Get this item's HTML Element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -95,43 +122,58 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Removes and destroys this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "enable", + "type" : "function", "desc" : "Enables this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setVisible", + "type" : "function", "desc" : "Convenience function for boolean show/hide.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -146,7 +188,9 @@ "events" : [ { "name" : "render", + "type" : "function", "desc" : "Fires when the button is rendered", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.Toolbar.Item.json b/docs/symbols/Roo.Toolbar.Item.json index b958ef9365..5c75c76f15 100644 --- a/docs/symbols/Roo.Toolbar.Item.json +++ b/docs/symbols/Roo.Toolbar.Item.json @@ -19,75 +19,102 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "disable", + "type" : "function", "desc" : "Disables this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "hide", + "type" : "function", "desc" : "Hides this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "show", + "type" : "function", "desc" : "Shows this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getEl", + "type" : "function", "desc" : "Get this item's HTML Element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -99,43 +126,58 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Removes and destroys this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "enable", + "type" : "function", "desc" : "Enables this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setVisible", + "type" : "function", "desc" : "Convenience function for boolean show/hide.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -150,8 +192,10 @@ "events" : [ { "name" : "render", + "type" : "function", "desc" : "Fires when the button is rendered", - "memberOf" : "Roo.Toolbar.Item", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.Toolbar.Separator.json b/docs/symbols/Roo.Toolbar.Separator.json index b7601ae1f7..2eb0a20b8b 100644 --- a/docs/symbols/Roo.Toolbar.Separator.json +++ b/docs/symbols/Roo.Toolbar.Separator.json @@ -14,75 +14,102 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "disable", + "type" : "function", "desc" : "Disables this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "hide", + "type" : "function", "desc" : "Hides this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "show", + "type" : "function", "desc" : "Shows this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getEl", + "type" : "function", "desc" : "Get this item's HTML Element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -94,43 +121,58 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Removes and destroys this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "enable", + "type" : "function", "desc" : "Enables this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setVisible", + "type" : "function", "desc" : "Convenience function for boolean show/hide.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -145,7 +187,9 @@ "events" : [ { "name" : "render", + "type" : "function", "desc" : "Fires when the button is rendered", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.Toolbar.Spacer.json b/docs/symbols/Roo.Toolbar.Spacer.json index 0cab403e44..7a5e98a129 100644 --- a/docs/symbols/Roo.Toolbar.Spacer.json +++ b/docs/symbols/Roo.Toolbar.Spacer.json @@ -14,75 +14,102 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "disable", + "type" : "function", "desc" : "Disables this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "hide", + "type" : "function", "desc" : "Hides this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "show", + "type" : "function", "desc" : "Shows this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getEl", + "type" : "function", "desc" : "Get this item's HTML Element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -94,43 +121,58 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Removes and destroys this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "enable", + "type" : "function", "desc" : "Enables this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setVisible", + "type" : "function", "desc" : "Convenience function for boolean show/hide.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -145,7 +187,9 @@ "events" : [ { "name" : "render", + "type" : "function", "desc" : "Fires when the button is rendered", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.Toolbar.SplitButton.json b/docs/symbols/Roo.Toolbar.SplitButton.json index dfece33631..f9192387b0 100644 --- a/docs/symbols/Roo.Toolbar.SplitButton.json +++ b/docs/symbols/Roo.Toolbar.SplitButton.json @@ -23,244 +23,240 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "String/Object", "desc" : "The tooltip for the button - can be a string or QuickTips config object", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "text", "type" : "String", "desc" : "The button text", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "renderTo", "type" : "String/HTMLElement/Element", "desc" : "The element to append the button to", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "hidden", "type" : "Boolean", "desc" : "True to start hidden (defaults to false)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "toggleGroup", "type" : "String", "desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "handleMouseEvents", "type" : "Boolean", "desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "menu", - "type" : "Mixed", + "type" : "Roo.menu.Menu", "desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "enableToggle", "type" : "Boolean", "desc" : "True to enable pressed/not pressed toggling (defaults to false)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "arrowHandler", "type" : "Function", "desc" : "A function called when the arrow button is clicked (can be used instead of click event)", - "memberOf" : "Roo.SplitButton", - "optvals" : [] + "memberOf" : "Roo.SplitButton" }, { "name" : "handler", "type" : "Function", "desc" : "A function called when the button is clicked (can be used instead of click event)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "scope", "type" : "Object", "desc" : "The scope of the handler", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "minWidth", "type" : "Number", "desc" : "The minimum width for this button (used to give a set of buttons a common width)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to start disabled (defaults to false)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "pressed", "type" : "Boolean", "desc" : "True to start pressed (only if enableToggle = true)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "template", "type" : "Roo.Template", "desc" : "(Optional)\nAn {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the button's main element.", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The DOM tabIndex for this button (defaults to undefined)", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "iconCls", "type" : "String", "desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "menuAlign", "type" : "String", "desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "icon", "type" : "String", "desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "tooltipType", "type" : "String", "desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "arrowTooltip", "type" : "String", "desc" : "The title attribute of the arrow", - "memberOf" : "Roo.SplitButton", - "optvals" : [] + "memberOf" : "Roo.SplitButton" }, { "name" : "clickEvent", "type" : "String", "desc" : "The type of event to map to the button's event handler (defaults to 'click')", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "repeat", "type" : "Boolean/Object", "desc" : "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" }, { "name" : "type", "type" : "String", "desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).", - "memberOf" : "Roo.Button", - "optvals" : [] + "memberOf" : "Roo.Button" } ], "methods" : [ { "name" : "destroy", + "type" : "function", "desc" : "Removes and destroys this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.SplitButton", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "hide", + "type" : "function", "desc" : "Hides this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.SplitButton", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "show", + "type" : "function", "desc" : "Shows this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.SplitButton", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setArrowHandler", + "type" : "function", "desc" : "Sets this button's arrow click handler", + "sig" : "(handler, scope)", + "static" : false, + "memberOf" : "Roo.SplitButton", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.SplitButton", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "handler", @@ -279,29 +275,39 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Focus the button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.SplitButton", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.SplitButton", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setHandler", + "type" : "function", "desc" : "Sets this button's click handler", + "sig" : "(handler, scope)", + "static" : false, + "memberOf" : "Roo.SplitButton", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.SplitButton", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "handler", @@ -320,43 +326,58 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "enable", + "type" : "function", "desc" : "Enable this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the button's underlying element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -368,15 +389,20 @@ }, { "name" : "setDisabled", + "type" : "function", "desc" : "Convenience function for boolean enable/disable", + "sig" : "(enabled)", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "enabled", @@ -389,15 +415,20 @@ }, { "name" : "setVisible", + "type" : "function", "desc" : "Convenience function for boolean show/hide", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -410,15 +441,20 @@ }, { "name" : "getText", + "type" : "function", "desc" : "Gets the text for this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -430,15 +466,20 @@ }, { "name" : "setText", + "type" : "function", "desc" : "Sets this button's text", + "sig" : "(text)", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "text", @@ -451,15 +492,20 @@ }, { "name" : "toggle", + "type" : "function", "desc" : "If a state it passed, it becomes the pressed state otherwise the current state is toggled.", + "sig" : "(state)", + "static" : false, + "memberOf" : "Roo.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "state", @@ -472,29 +518,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -525,15 +581,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -558,15 +619,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -579,15 +645,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -600,15 +671,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -633,15 +709,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -666,15 +747,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -693,15 +779,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -726,15 +817,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -767,7 +863,9 @@ "events" : [ { "name" : "arrowclick", + "type" : "function", "desc" : "Fires when this button's arrow is clicked", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.SplitButton", "example" : "", "deprecated" : "", @@ -791,7 +889,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires when the button is rendered", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", @@ -809,7 +909,9 @@ }, { "name" : "click", + "type" : "function", "desc" : "Fires when this button is clicked", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", @@ -833,7 +935,9 @@ }, { "name" : "mouseover", + "type" : "function", "desc" : "Fires when the mouse hovers over the button", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", @@ -857,7 +961,9 @@ }, { "name" : "toggle", + "type" : "function", "desc" : "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)", + "sig" : "function (_self, pressed)\n{\n\n}", "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", @@ -881,7 +987,9 @@ }, { "name" : "mouseout", + "type" : "function", "desc" : "Fires when the mouse exits the button", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.Button", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.Toolbar.TextItem.json b/docs/symbols/Roo.Toolbar.TextItem.json index 85518233f8..71f6bab8c2 100644 --- a/docs/symbols/Roo.Toolbar.TextItem.json +++ b/docs/symbols/Roo.Toolbar.TextItem.json @@ -14,83 +14,109 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "text", "type" : "string", "desc" : "", - "memberOf" : "Roo.Toolbar", - "optvals" : [] + "memberOf" : "Roo.Toolbar" } ], "methods" : [ { "name" : "disable", + "type" : "function", "desc" : "Disables this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "hide", + "type" : "function", "desc" : "Hides this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "show", + "type" : "function", "desc" : "Shows this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getEl", + "type" : "function", "desc" : "Get this item's HTML Element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -102,43 +128,58 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Removes and destroys this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "enable", + "type" : "function", "desc" : "Enables this item.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setVisible", + "type" : "function", "desc" : "Convenience function for boolean show/hide.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Toolbar.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -153,7 +194,9 @@ "events" : [ { "name" : "render", + "type" : "function", "desc" : "Fires when the button is rendered", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Toolbar.Item", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.Toolbar.json b/docs/symbols/Roo.Toolbar.json index bf912830ec..1cd3e71079 100644 --- a/docs/symbols/Roo.Toolbar.json +++ b/docs/symbols/Roo.Toolbar.json @@ -19,41 +19,45 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "text", "type" : "string", "desc" : "", - "memberOf" : "Roo.Toolbar", - "optvals" : [] + "memberOf" : "" }, { "name" : "container", "type" : "String/HTMLElement/Element", "desc" : "The id or element that will contain the toolbar", - "memberOf" : "Roo.Toolbar", - "optvals" : [] + "memberOf" : "" }, { "name" : "items", "type" : "Array", "desc" : "array of button configs or elements to add (will be converted to a MixedCollection)", - "memberOf" : "Roo.Toolbar", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "addDom", + "type" : "function", "desc" : "Adds a new element to the toolbar from the passed {@link Roo.DomHelper} config.", + "sig" : "(config)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -72,15 +76,20 @@ }, { "name" : "addElement", + "type" : "function", "desc" : "Adds any standard HTML element to the toolbar", + "sig" : "(el)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -99,15 +108,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the Element for this toolbar.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -119,29 +133,39 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide the toolbar", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "addSeparator", + "type" : "function", "desc" : "Adds a separator", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -153,29 +177,39 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show the toolbar", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "addFill", + "type" : "function", "desc" : "Adds a fill element that forces subsequent additions to the right side of the toolbar", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -187,15 +221,20 @@ }, { "name" : "addSpacer", + "type" : "function", "desc" : "Adds a spacer element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -207,15 +246,20 @@ }, { "name" : "add", + "type" : "function", "desc" : "Adds element(s) to the toolbar -- this function takes a variable number of \narguments of mixed type and adds them to the toolbar.", + "sig" : "(arg1, arg2)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "arg1", @@ -234,15 +278,20 @@ }, { "name" : "addField", + "type" : "function", "desc" : "Adds a dynamically rendered Roo.form field (TextField, ComboBox, etc).\nNote: the field should not have been rendered yet. For a field that has already been\nrendered, use {@link #addElement}.", + "sig" : "(field)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "field", @@ -261,15 +310,20 @@ }, { "name" : "addText", + "type" : "function", "desc" : "Adds text to the toolbar", + "sig" : "(text)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "text", @@ -288,15 +342,20 @@ }, { "name" : "addItem", + "type" : "function", "desc" : "Adds any Toolbar.Item or subclass", + "sig" : "(item)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "item", @@ -315,15 +374,20 @@ }, { "name" : "addButton", + "type" : "function", "desc" : "Adds a button (or buttons). See {@link Roo.Toolbar.Button} for more info on the config.", + "sig" : "(config)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -342,15 +406,20 @@ }, { "name" : "insertButton", + "type" : "function", "desc" : "Inserts any {@link Roo.Toolbar.Item}/{@link Roo.Toolbar.Button} at the specified index.", + "sig" : "(index, item)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -375,15 +444,20 @@ }, { "name" : "addxtype", + "type" : "function", "desc" : "Add an Xtype element", + "sig" : "(xtype)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Toolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "xtype", diff --git a/docs/symbols/Roo.TreePanel.json b/docs/symbols/Roo.TreePanel.json index d07e7ddf61..d4f0690d4f 100644 --- a/docs/symbols/Roo.TreePanel.json +++ b/docs/symbols/Roo.TreePanel.json @@ -22,145 +22,135 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "loadOnce", "type" : "Boolean", "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "autoScroll", "type" : "Boolean", "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "fitToFrame", "type" : "Boolean", "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "background", "type" : "Boolean", "desc" : "True if the panel should not be activated when it is added (defaults to false)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "toolbar", - "type" : "Toolbar", + "type" : "Roo.Toolbar", "desc" : "A toolbar for this panel", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "region", "type" : "String", - "desc" : "t) which region to put this panel on (when used with xtype constructors)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [ - "center", - "north", - "south", - "east", - "west" - ] + "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)", + "memberOf" : "Roo.ContentPanel" }, { "name" : "content", "type" : "String", "desc" : "Raw content to fill content panel with (uses setContent on construction.)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" + }, + { + "name" : "menu", + "type" : "Roo.menu.Menu", + "desc" : "popup menu", + "memberOf" : "Roo.ContentPanel" }, { "name" : "title", "type" : "String", "desc" : "The title for this panel", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "style", "type" : "String", "desc" : "Extra style to add to the content panel", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "autoCreate", - "type" : "Boolean/Object", + "type" : "Boolean|Object", "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "fitContainer", "type" : "Boolean", "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "closable", "type" : "Boolean", "desc" : "True if the panel can be closed/removed", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "params", - "type" : "String/Object", + "type" : "String|Object", "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "adjustments", "type" : "Array", "desc" : "Values to add to the width/height when doing a {@link #fitToFrame} (default is [0, 0])", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "url", "type" : "String", "desc" : "Calls {@link #setUrl} with this value", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" }, { "name" : "resizeEl", - "type" : "String/HTMLElement/Element", + "type" : "String|HTMLElement|Element", "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)", - "memberOf" : "Roo.ContentPanel", - "optvals" : [] + "memberOf" : "Roo.ContentPanel" } ], "methods" : [ { "name" : "load", + "type" : "function", "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.", + "sig" : "(url, params, callback, discardUrl)", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "url", @@ -197,15 +187,20 @@ }, { "name" : "getUpdateManager", + "type" : "function", "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -217,15 +212,20 @@ }, { "name" : "isClosable", + "type" : "function", "desc" : "Returns true is this panel was configured to be closable", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -237,29 +237,39 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Destroys this panel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getEl", + "type" : "function", "desc" : "Returns this panel's element - used by regiosn to add.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -271,15 +281,20 @@ }, { "name" : "setContent", + "type" : "function", "desc" : "Updates this panel's element", + "sig" : "(content, loadScripts)", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "content", @@ -298,15 +313,20 @@ }, { "name" : "getId", + "type" : "function", "desc" : "Returns this panel's id", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -318,15 +338,20 @@ }, { "name" : "addxtype", + "type" : "function", "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n
\n\nlayout.addxtype({\n       xtype : 'Form',\n       items: [ .... ]\n   }\n);\n\n
", + "sig" : "(cfg)", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cfg", @@ -339,29 +364,39 @@ }, { "name" : "refresh", + "type" : "function", "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getTitle", + "type" : "function", "desc" : "Returns this panel's title", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -373,15 +408,20 @@ }, { "name" : "setTitle", + "type" : "function", "desc" : "Set this panel's title", + "sig" : "(title)", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "title", @@ -394,15 +434,20 @@ }, { "name" : "getToolbar", + "type" : "function", "desc" : "Returns the toolbar for this Panel if one was configured.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -414,15 +459,20 @@ }, { "name" : "setUrl", + "type" : "function", "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.", + "sig" : "(url, params, loadOnce)", + "static" : false, + "memberOf" : "Roo.ContentPanel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "url", @@ -453,29 +503,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -506,15 +566,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -539,15 +604,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -560,15 +630,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -581,15 +656,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -614,15 +694,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -647,15 +732,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -674,15 +764,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -707,15 +802,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -748,7 +848,9 @@ "events" : [ { "name" : "deactivate", + "type" : "function", "desc" : "Fires when this panel is activated.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", @@ -766,7 +868,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires when this panel is resized if fitToFrame is true.", + "sig" : "function (_self, width, height)\n{\n\n}", "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", @@ -796,7 +900,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires when this tab is created", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", @@ -814,7 +920,9 @@ }, { "name" : "activate", + "type" : "function", "desc" : "Fires when this panel is activated.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.ContentPanel", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.UpdateManager.BasicRenderer.json b/docs/symbols/Roo.UpdateManager.BasicRenderer.json index 57cf9c3f6d..2ce63aaf8b 100644 --- a/docs/symbols/Roo.UpdateManager.BasicRenderer.json +++ b/docs/symbols/Roo.UpdateManager.BasicRenderer.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "render", + "type" : "function", "desc" : "This is called when the transaction is completed and it's time to update the element - The BasicRenderer\nupdates the elements innerHTML with the responseText - To perform a custom render (i.e. XML or JSON processing),\ncreate an object with a \"render(el, response)\" method and pass it to setRenderer on the UpdateManager.", + "sig" : "(el, response, updateManager, callback)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.UpdateManager.BasicRenderer", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", diff --git a/docs/symbols/Roo.UpdateManager.defaults.json b/docs/symbols/Roo.UpdateManager.defaults.json index 0d4bdcdfc6..fd4a6b1019 100644 --- a/docs/symbols/Roo.UpdateManager.defaults.json +++ b/docs/symbols/Roo.UpdateManager.defaults.json @@ -12,6 +12,8 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.UpdateManager.json b/docs/symbols/Roo.UpdateManager.json index a2807ceb48..9c4fa79928 100644 --- a/docs/symbols/Roo.UpdateManager.json +++ b/docs/symbols/Roo.UpdateManager.json @@ -27,27 +27,33 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" } ], "methods" : [ { "name" : "update", + "type" : "function", "desc" : "Performs an async request, updating this element with the response. If params are specified it uses POST, otherwise it uses GET.", + "sig" : "(url, params, callback, discardUrl)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.UpdateManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "url", @@ -78,29 +84,39 @@ }, { "name" : "showLoading", + "type" : "function", "desc" : "Called to update the element to \"Loading\" state. Override to perform custom action.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.UpdateManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setDefaultUrl", + "type" : "function", "desc" : "Set the defaultUrl used for updates", + "sig" : "(defaultUrl)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.UpdateManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "defaultUrl", @@ -113,15 +129,20 @@ }, { "name" : "updateElement", + "type" : "function", "desc" : "Static convenience method. This method is deprecated in favor of el.load({url:'foo.php', ...}).\nUsage:\n
Roo.UpdateManager.updateElement(\"my-div\", \"stuff.php\");
", + "sig" : "(el, url, params, options)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.UpdateManager", "example" : "", "deprecated" : "This has been deprecated: ", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -152,15 +173,20 @@ }, { "name" : "refresh", + "type" : "function", "desc" : "Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately", + "sig" : "(callback)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.UpdateManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "callback", @@ -173,15 +199,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Get the Element this UpdateManager is bound to", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.UpdateManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -193,15 +224,20 @@ }, { "name" : "isUpdating", + "type" : "function", "desc" : "Returns true if an update is in progress", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.UpdateManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -213,29 +249,39 @@ }, { "name" : "stopAutoRefresh", + "type" : "function", "desc" : "Stop auto refresh on this element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.UpdateManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "startAutoRefresh", + "type" : "function", "desc" : "Set this element to auto refresh.", + "sig" : "(interval, url, params, callback, refreshNow)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.UpdateManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "interval", @@ -272,29 +318,39 @@ }, { "name" : "abort", + "type" : "function", "desc" : "Aborts the executing transaction", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.UpdateManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRenderer", + "type" : "function", "desc" : "Set the content renderer for this UpdateManager. See {@link Roo.UpdateManager.BasicRenderer#render} for more details.", + "sig" : "(renderer)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.UpdateManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "renderer", @@ -307,15 +363,20 @@ }, { "name" : "formUpdate", + "type" : "function", "desc" : "Performs an async form post, updating this element with the response. If the form has the attribute enctype=\"multipart/form-data\", it assumes it's a file upload.\nUses this.sslBlankUrl for SSL file uploads to prevent IE security warning.", + "sig" : "(form, url, reset, callback)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.UpdateManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "form", @@ -346,29 +407,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -399,15 +470,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -432,15 +508,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -453,15 +534,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -474,15 +560,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -507,15 +598,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -540,15 +636,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -567,15 +668,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -600,15 +706,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -641,8 +752,10 @@ "events" : [ { "name" : "update", + "type" : "function", "desc" : "Fired after successful update is made.", - "memberOf" : "Roo.UpdateManager", + "sig" : "function (el, oResponseObject)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -665,8 +778,10 @@ }, { "name" : "beforeupdate", + "type" : "function", "desc" : "Fired before an update is made, return false from your handler and the update is cancelled.", - "memberOf" : "Roo.UpdateManager", + "sig" : "function (el, url, params)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -695,8 +810,10 @@ }, { "name" : "failure", + "type" : "function", "desc" : "Fired on update failure.", - "memberOf" : "Roo.UpdateManager", + "sig" : "function (el, oResponseObject)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.View.json b/docs/symbols/Roo.View.json index 78f13f9ee8..6e9ca36d6c 100644 --- a/docs/symbols/Roo.View.json +++ b/docs/symbols/Roo.View.json @@ -21,104 +21,99 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "selectedClass", "type" : "String", "desc" : "The css class to add to selected nodes", - "memberOf" : "Roo.View", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "dataName", "type" : "String", "desc" : "the named area of the template to use as the data area\n Works with domtemplates roo-name=\"name\"", - "memberOf" : "Roo.View", - "optvals" : [] + "memberOf" : "" }, { "name" : "text", "type" : "String", "desc" : "to display on mask (default Loading)", - "memberOf" : "Roo.View", - "optvals" : [] + "memberOf" : "" }, { "name" : "multiSelect", "type" : "Boolean", "desc" : "Allow multiple selection", - "memberOf" : "Roo.View", - "optvals" : [] + "memberOf" : "" }, { "name" : "emptyText", "type" : "String", "desc" : "The empty text to show when nothing is loaded.", - "memberOf" : "Roo.View", - "optvals" : [] + "memberOf" : "" }, { "name" : "store", "type" : "Roo.data.Store", "desc" : "Data store to load data from.", - "memberOf" : "Roo.View", - "optvals" : [] + "memberOf" : "" }, { "name" : "toggleSelect", "type" : "Boolean", "desc" : "- selecting", - "memberOf" : "Roo.View", - "optvals" : [] + "memberOf" : "" }, { "name" : "singleSelect", "type" : "Boolean", "desc" : "Allow single selection", - "memberOf" : "Roo.View", - "optvals" : [] + "memberOf" : "" }, { "name" : "tickable", "type" : "Boolean", "desc" : "- selecting", - "memberOf" : "Roo.View", - "optvals" : [] + "memberOf" : "" }, { "name" : "el", "type" : "String|Roo.Element", "desc" : "The container element.", - "memberOf" : "Roo.View", - "optvals" : [] + "memberOf" : "" }, { "name" : "tpl", "type" : "String|Roo.Template", "desc" : "The template used by this View", - "memberOf" : "Roo.View", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "getSelectedNodes", + "type" : "function", "desc" : "Get the currently selected nodes.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -130,15 +125,20 @@ }, { "name" : "getNodes", + "type" : "function", "desc" : "Gets a range template nodes.", + "sig" : "(startIndex, endIndex)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "startIndex", @@ -163,15 +163,20 @@ }, { "name" : "select", + "type" : "function", "desc" : "Selects nodes.", + "sig" : "(nodeInfo, keepExisting, suppressEvent)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "nodeInfo", @@ -196,15 +201,20 @@ }, { "name" : "clearSelections", + "type" : "function", "desc" : "Clear all selections", + "sig" : "(suppressEvent)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "suppressEvent", @@ -217,15 +227,20 @@ }, { "name" : "isSelected", + "type" : "function", "desc" : "Returns true if the passed node is selected", + "sig" : "(node)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -244,43 +259,58 @@ }, { "name" : "refresh", + "type" : "function", "desc" : "Refreshes the view. - called by datachanged on the store. - do not call directly.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onBeforeLoad", + "type" : "function", "desc" : "onbeforeLoad - masks the loading area.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getSelectedIndexes", + "type" : "function", "desc" : "Get the indexes of the selected nodes.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -292,15 +322,20 @@ }, { "name" : "indexOf", + "type" : "function", "desc" : "Finds the index of the passed node", + "sig" : "(nodeInfo)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "nodeInfo", @@ -319,15 +354,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the element this view is bound to.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -339,15 +379,20 @@ }, { "name" : "setStore", + "type" : "function", "desc" : "Changes the data store this view uses and refresh the view.", + "sig" : "(store)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "store", @@ -360,15 +405,20 @@ }, { "name" : "refreshNode", + "type" : "function", "desc" : "Refresh an individual node.", + "sig" : "(index)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -381,15 +431,20 @@ }, { "name" : "prepareData", + "type" : "function", "desc" : "Function to override to reformat the data that is sent to\nthe template for each node.\nDEPRICATED - use the preparedata event handler.", + "sig" : "(data)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "data", @@ -402,15 +457,20 @@ }, { "name" : "getSelectionCount", + "type" : "function", "desc" : "Get the number of selected nodes.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -422,15 +482,20 @@ }, { "name" : "findItemFromChild", + "type" : "function", "desc" : "Returns the template node the passed child belongs to or null if it doesn't belong to one.", + "sig" : "(node)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -449,15 +514,20 @@ }, { "name" : "unselect", + "type" : "function", "desc" : "Unselects nodes.", + "sig" : "(nodeInfo, keepExisting, suppressEvent)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "nodeInfo", @@ -482,15 +552,20 @@ }, { "name" : "getNode", + "type" : "function", "desc" : "Gets a template node.", + "sig" : "(nodeInfo)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.View", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "nodeInfo", @@ -509,29 +584,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -562,15 +647,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -595,15 +685,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -616,15 +711,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -637,15 +737,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -670,15 +775,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -703,15 +813,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -730,15 +845,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -763,15 +883,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -804,8 +929,10 @@ "events" : [ { "name" : "dblclick", + "type" : "function", "desc" : "Fires when a template node is double clicked.", - "memberOf" : "Roo.View", + "sig" : "function (_self, index, node, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -840,8 +967,10 @@ }, { "name" : "preparedata", + "type" : "function", "desc" : "Fires on every row to render, to allow you to change the data.", - "memberOf" : "Roo.View", + "sig" : "function (_self, data)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -864,8 +993,10 @@ }, { "name" : "selectionchange", + "type" : "function", "desc" : "Fires when the selected nodes change.", - "memberOf" : "Roo.View", + "sig" : "function (_self, selections)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -888,8 +1019,10 @@ }, { "name" : "beforeselect", + "type" : "function", "desc" : "Fires before a selection is made. If any handlers return false, the selection is cancelled.", - "memberOf" : "Roo.View", + "sig" : "function (_self, node, selections)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -918,8 +1051,10 @@ }, { "name" : "beforeclick", + "type" : "function", "desc" : "Fires before a click is processed. Returns false to cancel the default action.", - "memberOf" : "Roo.View", + "sig" : "function (_self, index, node, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -954,8 +1089,10 @@ }, { "name" : "click", + "type" : "function", "desc" : "Fires when a template node is clicked.", - "memberOf" : "Roo.View", + "sig" : "function (_self, index, node, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -990,8 +1127,10 @@ }, { "name" : "contextmenu", + "type" : "function", "desc" : "Fires when a template node is right clicked.", - "memberOf" : "Roo.View", + "sig" : "function (_self, index, node, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.XComponent.event.events.json b/docs/symbols/Roo.XComponent.event.events.json index 0e261b2870..e7dd4aa3ac 100644 --- a/docs/symbols/Roo.XComponent.event.events.json +++ b/docs/symbols/Roo.XComponent.event.events.json @@ -12,6 +12,8 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.XComponent.json b/docs/symbols/Roo.XComponent.json index 8e63e8afab..96b2ffed1f 100644 --- a/docs/symbols/Roo.XComponent.json +++ b/docs/symbols/Roo.XComponent.json @@ -21,69 +21,69 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "region", "type" : "String", "desc" : "Region to render component to (defaults to center)", - "memberOf" : "Roo.XComponent", - "optvals" : [] + "memberOf" : "" }, { "name" : "disabled", "type" : "Function|boolean", "desc" : "If this module is disabled by some rule, return true from the funtion", - "memberOf" : "Roo.XComponent", - "optvals" : [] + "memberOf" : "" }, { "name" : "order", "type" : "String", "desc" : "Used to set the order in which elements are created (usefull for multiple tabs)", - "memberOf" : "Roo.XComponent", - "optvals" : [] + "memberOf" : "" }, { "name" : "items", "type" : "Array", "desc" : "A single item array - the first element is the root of the tree..\nIt's done this way to stay compatible with the Xtype system...", - "memberOf" : "Roo.XComponent", - "optvals" : [] + "memberOf" : "" }, { "name" : "parent", "type" : "String", "desc" : "Name of parent element which it get xtype added to..", - "memberOf" : "Roo.XComponent", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "String", "desc" : "String to display while loading.", - "memberOf" : "Roo.XComponent", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "overlayStrings", + "type" : "function", "desc" : "Overlay a set of modified strings onto a component\nThis is dependant on our builder exporting the strings and 'named strings' elements.", + "sig" : "(element, associative)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.XComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "element", @@ -102,43 +102,58 @@ }, { "name" : "preBuild", + "type" : "function", "desc" : "move modules into their correct place in the tree..", + "sig" : "()\n{\n\n}", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.XComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "toObject", + "type" : "function", "desc" : "convert a string to an object..\neg. 'AAA.BBB' -> finds AAA.BBB", + "sig" : "()\n{\n\n}", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.XComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "render", + "type" : "function", "desc" : "render\nrender element to dom or tree", + "sig" : "(optional)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.XComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "optional", @@ -151,15 +166,20 @@ }, { "name" : "buildOrder", + "type" : "function", "desc" : "make a list of modules to build.", + "sig" : "()\n{\n\n}", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.XComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -171,29 +191,39 @@ }, { "name" : "register", + "type" : "function", "desc" : "Register components to be built later.\n\nThis solves the following issues\n- Building is not done on page load, but after an authentication process has occured.\n- Interface elements are registered on page load\n- Parent Interface elements may not be loaded before child, so this handles that..\n\n\nexample:\n\nMyApp.register({\n order : '000001',\n module : 'Pman.Tab.projectMgr',\n region : 'center',\n parent : 'Pman.layout',\n disabled : false, // or use a function..\n })\n* @param {Object} details about module", + "sig" : "()\n{\n\n}", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.XComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "build", + "type" : "function", "desc" : "Build the registered modules.", + "sig" : "(parent, optional)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.XComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "parent", @@ -212,29 +242,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -259,15 +299,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -280,15 +325,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -301,15 +351,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -334,15 +389,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -367,15 +427,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -394,15 +459,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -427,15 +497,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -468,8 +543,10 @@ "events" : [ { "name" : "built", + "type" : "function", "desc" : "Fires when this the componnt is built", - "memberOf" : "Roo.XComponent", + "sig" : "function (c)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.XTemplate.json b/docs/symbols/Roo.XTemplate.json index d7f671f79c..e9b42a02db 100644 --- a/docs/symbols/Roo.XTemplate.json +++ b/docs/symbols/Roo.XTemplate.json @@ -14,41 +14,45 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "onLoad", "type" : "Function", "desc" : "Called after the template has been loaded and complied (usually from a remove source)", - "memberOf" : "Roo.Template", - "optvals" : [] + "memberOf" : "Roo.Template" }, { "name" : "html", "type" : "String", "desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")", - "memberOf" : "Roo.Template", - "optvals" : [] + "memberOf" : "Roo.Template" }, { "name" : "url", "type" : "String", "desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n it should be fixed so that template is observable...", - "memberOf" : "Roo.Template", - "optvals" : [] + "memberOf" : "Roo.Template" } ], "methods" : [ { "name" : "applySubTemplate", + "type" : "function", "desc" : "same as applyTemplate, except it's done to one of the subTemplates\nwhen using named templates, you can do:\n\nvar str = pl.applySubTemplate('your-name', values);", + "sig" : "(id, values, parent)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.XTemplate", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -73,29 +77,39 @@ }, { "name" : "compile", + "type" : "function", "desc" : "compile the template\n\nThis is not recursive, so I'm not sure how nested templates are really going to be handled..", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.XTemplate", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "insertFirst", + "type" : "function", "desc" : "Applies the supplied values to the template and inserts the new node(s) as the first child of el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -126,15 +140,20 @@ }, { "name" : "overwrite", + "type" : "function", "desc" : "Applies the supplied values to the template and overwrites the content of el with the new node(s).", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -165,15 +184,20 @@ }, { "name" : "insertBefore", + "type" : "function", "desc" : "Applies the supplied values to the template and inserts the new node(s) before el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -204,15 +228,20 @@ }, { "name" : "applyTemplate", + "type" : "function", "desc" : "Returns an HTML fragment of this template with the specified values applied.", + "sig" : "(values)", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "values", @@ -231,15 +260,20 @@ }, { "name" : "set", + "type" : "function", "desc" : "Sets the HTML used as the template and optionally compiles it.", + "sig" : "(html, compile)", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "html", @@ -264,15 +298,20 @@ }, { "name" : "from", + "type" : "function", "desc" : "Creates a template from the passed element's value (display:none textarea, preferred) or innerHTML.", + "sig" : "(el)", + "static" : true, + "memberOf" : "Roo.Template", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -285,15 +324,20 @@ }, { "name" : "insertAfter", + "type" : "function", "desc" : "Applies the supplied values to the template and inserts the new node(s) after el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -324,15 +368,20 @@ }, { "name" : "append", + "type" : "function", "desc" : "Applies the supplied values to the template and appends the new node(s) to el.", + "sig" : "(el, values, returnElement)", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -363,15 +412,20 @@ }, { "name" : "apply", + "type" : "function", "desc" : "Alias for {@link #applyTemplate}", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Template", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Template", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] } diff --git a/docs/symbols/Roo.bootstrap.Alert.json b/docs/symbols/Roo.bootstrap.Alert.json index 73d6dad78f..4aab7d0201 100644 --- a/docs/symbols/Roo.bootstrap.Alert.json +++ b/docs/symbols/Roo.bootstrap.Alert.json @@ -23,171 +23,147 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "title", "type" : "String", "desc" : "The title of alert", - "memberOf" : "Roo.bootstrap.Alert", - "optvals" : [] + "memberOf" : "" }, { "name" : "seconds", "type" : "Number", "desc" : "default:-1 Number of seconds until it disapears (-1 means never.)", - "memberOf" : "Roo.bootstrap.Alert", - "optvals" : [] + "memberOf" : "" }, { "name" : "close", "type" : "Boolean", "desc" : "true to show a x closer", - "memberOf" : "Roo.bootstrap.Alert", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "html", "type" : "String", "desc" : "The content of alert", - "memberOf" : "Roo.bootstrap.Alert", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "weight", "type" : "String", "desc" : "r) Weight of the message", - "memberOf" : "Roo.bootstrap.Alert", - "optvals" : [ - "success", - "info", - "warning", - "danger" - ] + "memberOf" : "" }, { "name" : "fa", "type" : "String", "desc" : "font-awesomeicon", - "memberOf" : "Roo.bootstrap.Alert", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "setTitle", + "type" : "function", "desc" : "Set the Title Message HTML", + "sig" : "(html)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Alert", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "html", @@ -200,15 +176,20 @@ }, { "name" : "setHtml", + "type" : "function", "desc" : "Set the Body Message HTML", + "sig" : "(html)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Alert", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "html", @@ -221,15 +202,20 @@ }, { "name" : "setWeight", + "type" : "function", "desc" : "Set the Weight of the alert", + "sig" : "((success|info|warning|danger))", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Alert", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "(success|info|warning|danger)", @@ -242,15 +228,20 @@ }, { "name" : "setIcon", + "type" : "function", "desc" : "Set the Icon of the alert", + "sig" : "(see)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Alert", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "see", @@ -263,43 +254,58 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide the Alert", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Alert", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "show", + "type" : "function", "desc" : "Show the Alert", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Alert", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -311,57 +317,77 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -373,15 +399,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -393,15 +424,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -414,43 +450,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -463,15 +514,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -490,15 +546,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -510,15 +571,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -537,15 +603,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -557,15 +628,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -577,29 +653,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -630,15 +716,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -663,15 +754,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -684,15 +780,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -705,15 +806,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -738,15 +844,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -771,15 +882,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -798,15 +914,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -831,15 +952,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -872,7 +998,9 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -890,7 +1018,9 @@ }, { "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" : "", @@ -908,7 +1038,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -926,7 +1058,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -944,7 +1078,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -962,7 +1098,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -980,7 +1118,9 @@ }, { "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" : "", @@ -998,7 +1138,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1016,7 +1158,9 @@ }, { "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" : "", @@ -1034,7 +1178,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1052,7 +1198,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.BezierSignature.json b/docs/symbols/Roo.bootstrap.BezierSignature.json index 62a1c624ef..115039694f 100644 --- a/docs/symbols/Roo.bootstrap.BezierSignature.json +++ b/docs/symbols/Roo.bootstrap.BezierSignature.json @@ -23,187 +23,165 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "Callback", "type" : "function", "desc" : "when stroke begin.", - "memberOf" : "Roo.bootstrap.BezierSignature", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "Radius", "type" : "float|function", "desc" : "of a single dot.", - "memberOf" : "Roo.bootstrap.BezierSignature", - "optvals" : [] + "memberOf" : "" }, { "name" : "canvas", "type" : "int", "desc" : "height", - "memberOf" : "Roo.bootstrap.BezierSignature", - "optvals" : [] + "memberOf" : "" }, { "name" : "Add", "type" : "integer", "desc" : "the next point only if the previous one is farther than x pixels. Defaults to 5.", - "memberOf" : "Roo.bootstrap.BezierSignature", - "optvals" : [] + "memberOf" : "" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "Weight", "type" : "float", "desc" : "used to modify new velocity based on the previous velocity. Defaults to 0.7.", - "memberOf" : "Roo.bootstrap.BezierSignature", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "Draw", "type" : "integer", "desc" : "the next point at most once per every x milliseconds. Set it to 0 to turn off throttling. Defaults to 16.", - "memberOf" : "Roo.bootstrap.BezierSignature", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "Color", "type" : "string", "desc" : "used to draw the lines. Can be any color format accepted by context.fillStyle. Defaults to \"black\".", - "memberOf" : "Roo.bootstrap.BezierSignature", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "Minimum", "type" : "float", "desc" : "width of a line. Defaults to 0.5.", - "memberOf" : "Roo.bootstrap.BezierSignature", - "optvals" : [] + "memberOf" : "" }, { "name" : "Maximum", "type" : "float", "desc" : "width of a line. Defaults to 2.5.", - "memberOf" : "Roo.bootstrap.BezierSignature", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -215,85 +193,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -305,15 +313,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -325,15 +338,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -346,43 +364,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -395,15 +428,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -422,15 +460,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -442,15 +485,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -469,15 +517,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -489,15 +542,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -509,29 +567,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -562,15 +630,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -595,15 +668,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -616,15 +694,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -637,15 +720,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -670,15 +758,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -703,15 +796,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -730,15 +828,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -763,15 +866,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -804,7 +912,9 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -822,7 +932,9 @@ }, { "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" : "", @@ -840,7 +952,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -858,7 +972,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -876,7 +992,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -894,7 +1012,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -912,7 +1032,9 @@ }, { "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" : "", @@ -930,7 +1052,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -948,7 +1072,9 @@ }, { "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" : "", @@ -966,7 +1092,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -984,7 +1112,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Body.json b/docs/symbols/Roo.bootstrap.Body.json index ad29ae92de..3b0d8f81cd 100644 --- a/docs/symbols/Roo.bootstrap.Body.json +++ b/docs/symbols/Roo.bootstrap.Body.json @@ -23,124 +23,111 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -152,85 +139,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -242,15 +259,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -262,15 +284,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -283,43 +310,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -332,15 +374,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -359,15 +406,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -379,15 +431,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -406,15 +463,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -426,15 +488,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -446,29 +513,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -499,15 +576,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -532,15 +614,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -553,15 +640,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -574,15 +666,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -607,15 +704,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -640,15 +742,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -667,15 +774,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -700,15 +812,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -741,7 +858,9 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -759,7 +878,9 @@ }, { "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" : "", @@ -777,7 +898,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -795,7 +918,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -813,7 +938,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -831,7 +958,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -849,7 +978,9 @@ }, { "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" : "", @@ -867,7 +998,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -885,7 +1018,9 @@ }, { "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" : "", @@ -903,7 +1038,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -921,7 +1058,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Brick.json b/docs/symbols/Roo.bootstrap.Brick.json index dc804279e3..a493e439b8 100644 --- a/docs/symbols/Roo.bootstrap.Brick.json +++ b/docs/symbols/Roo.bootstrap.Brick.json @@ -23,166 +23,147 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "video", "type" : "String", "desc" : "", - "memberOf" : "Roo.bootstrap.Brick", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "title", "type" : "String", "desc" : "", - "memberOf" : "Roo.bootstrap.Brick", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "html", "type" : "String", "desc" : "", - "memberOf" : "Roo.bootstrap.Brick", - "optvals" : [] + "memberOf" : "" }, { "name" : "square", "type" : "Boolean", "desc" : "", - "memberOf" : "Roo.bootstrap.Brick", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "", - "memberOf" : "Roo.bootstrap.Brick", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "href", "type" : "String", "desc" : "", - "memberOf" : "Roo.bootstrap.Brick", - "optvals" : [] + "memberOf" : "" }, { "name" : "bgimage", "type" : "String", "desc" : "", - "memberOf" : "Roo.bootstrap.Brick", - "optvals" : [] + "memberOf" : "" } ], "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -194,85 +175,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -284,15 +295,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -304,15 +320,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -325,43 +346,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -374,15 +410,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -401,15 +442,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -421,15 +467,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -448,15 +499,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -468,15 +524,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -488,29 +549,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -541,15 +612,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -574,15 +650,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -595,15 +676,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -616,15 +702,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -649,15 +740,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -682,15 +778,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -709,15 +810,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -742,15 +848,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -783,8 +894,10 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "When a Brick is click", - "memberOf" : "Roo.bootstrap.Brick", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -807,7 +920,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -825,7 +940,9 @@ }, { "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" : "", @@ -843,7 +960,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -861,7 +980,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -879,7 +1000,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -897,7 +1020,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -915,7 +1040,9 @@ }, { "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" : "", @@ -933,7 +1060,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -951,7 +1080,9 @@ }, { "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" : "", @@ -969,7 +1100,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -987,7 +1120,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Button.json b/docs/symbols/Roo.bootstrap.Button.json index 338f54f2b5..f627d658a7 100644 --- a/docs/symbols/Roo.bootstrap.Button.json +++ b/docs/symbols/Roo.bootstrap.Button.json @@ -23,331 +23,262 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "toggle", "type" : "Boolean", "desc" : "is it a slidy toggle button", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "inverse", "type" : "Boolean", "desc" : "dark themed version", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "badge", "type" : "String", "desc" : "text for badge", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "disabled", "type" : "Boolean", "desc" : "default false;", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "weight", "type" : "String", "desc" : "k) default", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "default", - "primary", - "secondary", - "success", - "info", - "warning", - "danger", - "link", - "light", - "dark" - ] + "memberOf" : "" }, { "name" : "grpup", "type" : "Boolean", "desc" : "if parent is a btn group - then it turns it into a toogleGroup.", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "ontext", "type" : "String", "desc" : "text for on slidy toggle state", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "preventDefault", "type" : "Boolean", "desc" : "default true (stop click event triggering the URL if it's a link.)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "theme", "type" : "String", "desc" : "w)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "default", - "glow" - ] + "memberOf" : "" }, { "name" : "target", "type" : "String", "desc" : "r) target for a href.", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "_self", - "_blank", - "_parent", - "_top", - "other" - ] + "memberOf" : "" }, { "name" : "glyphicon", "type" : "String", "desc" : "depricated - use fa", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "isClose", "type" : "Boolean", "desc" : "default false;", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "fa", "type" : "String", "desc" : "fontawesome icon - eg. 'comment' - without the fa/fas etc..", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "size", "type" : "String", "desc" : "s)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "lg", - "sm", - "xs" - ] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "badge_weight", "type" : "String", "desc" : "k) default (same as button)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "default", - "primary", - "secondary", - "success", - "info", - "warning", - "danger", - "link", - "light", - "dark" - ] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "href", "type" : "String", "desc" : "empty or href", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "tag", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "a", - "input", - "submit" - ] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "outline", "type" : "Boolean", "desc" : "default false (except for weight=default which emulates old behaveiour with an outline)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "offtext", "type" : "String", "desc" : "text for off slidy toggle state", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "removeClass", "type" : "Boolean", "desc" : "remove the standard class..", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "html", "type" : "String", "desc" : "The button content", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "" }, { "name" : "pressed", "type" : "Boolean", "desc" : "default null - if the button ahs active state", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "setText", + "type" : "function", "desc" : "set the text of the first selected button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isActive", + "type" : "function", "desc" : "get the current active state", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -359,15 +290,20 @@ }, { "name" : "setActive", + "type" : "function", "desc" : "sets the active state on/off,", + "sig" : "(state)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "state", @@ -380,71 +316,96 @@ }, { "name" : "toggleActive", + "type" : "function", "desc" : "toggles the current active state", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getText", + "type" : "function", "desc" : "get the text of the first selected button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "enable", + "type" : "function", "desc" : "Enables this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "disable", + "type" : "function", "desc" : "Disable this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Button", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -456,85 +417,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -546,15 +537,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -566,15 +562,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -587,43 +588,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -636,15 +652,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -663,15 +684,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -690,15 +716,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -710,29 +741,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -763,15 +804,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -796,15 +842,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -817,15 +868,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -838,15 +894,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -871,15 +932,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -904,15 +970,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -931,15 +1002,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -964,15 +1040,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1005,8 +1086,10 @@ "events" : [ { "name" : "toggle", + "type" : "function", "desc" : "After the button has been toggles", - "memberOf" : "Roo.bootstrap.Button", + "sig" : "function (btn, e, pressed)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1035,8 +1118,10 @@ }, { "name" : "dblclick", + "type" : "function", "desc" : "When a button is double clicked", - "memberOf" : "Roo.bootstrap.Button", + "sig" : "function (btn, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1059,8 +1144,10 @@ }, { "name" : "click", + "type" : "function", "desc" : "When a button is pressed", - "memberOf" : "Roo.bootstrap.Button", + "sig" : "function (btn, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1083,7 +1170,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1101,7 +1190,9 @@ }, { "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" : "", @@ -1119,7 +1210,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1137,7 +1230,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1155,7 +1250,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1173,7 +1270,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1191,7 +1290,9 @@ }, { "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" : "", @@ -1209,7 +1310,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1227,7 +1330,9 @@ }, { "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" : "", @@ -1245,7 +1350,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1263,7 +1370,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.ButtonGroup.json b/docs/symbols/Roo.bootstrap.ButtonGroup.json index 46f93e55ff..5c28d316dc 100644 --- a/docs/symbols/Roo.bootstrap.ButtonGroup.json +++ b/docs/symbols/Roo.bootstrap.ButtonGroup.json @@ -23,173 +23,160 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "btn", "type" : "Boolean", "desc" : "true | false", - "memberOf" : "Roo.bootstrap.ButtonGroup", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "align", "type" : "String", "desc" : "vertical | justified (default none)", - "memberOf" : "Roo.bootstrap.ButtonGroup", - "optvals" : [] + "memberOf" : "" }, { "name" : "direction", "type" : "String", "desc" : "up | down (default down)", - "memberOf" : "Roo.bootstrap.ButtonGroup", - "optvals" : [] + "memberOf" : "" }, { "name" : "toolbar", "type" : "Boolean", "desc" : "false | true", - "memberOf" : "Roo.bootstrap.ButtonGroup", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "size", "type" : "String", "desc" : "lg | sm | xs (default empty normal)", - "memberOf" : "Roo.bootstrap.ButtonGroup", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "addItem", + "type" : "function", "desc" : "Add a button to the group (similar to NavItem API.)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ButtonGroup", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -201,85 +188,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -291,15 +308,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -311,15 +333,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -332,43 +359,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -381,15 +423,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -408,15 +455,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -428,15 +480,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -455,15 +512,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -475,15 +537,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -495,29 +562,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -548,15 +625,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -581,15 +663,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -602,15 +689,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -623,15 +715,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -656,15 +753,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -689,15 +791,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -716,15 +823,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -749,15 +861,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -790,7 +907,9 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -808,7 +927,9 @@ }, { "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" : "", @@ -826,7 +947,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -844,7 +967,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -862,7 +987,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -880,7 +1007,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -898,7 +1027,9 @@ }, { "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" : "", @@ -916,7 +1047,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -934,7 +1067,9 @@ }, { "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" : "", @@ -952,7 +1087,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -970,7 +1107,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.ButtonUploader.json b/docs/symbols/Roo.bootstrap.ButtonUploader.json index 2e4936063f..86f3ec2aa8 100644 --- a/docs/symbols/Roo.bootstrap.ButtonUploader.json +++ b/docs/symbols/Roo.bootstrap.ButtonUploader.json @@ -24,338 +24,261 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "toggle", "type" : "Boolean", "desc" : "is it a slidy toggle button", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "inverse", "type" : "Boolean", "desc" : "dark themed version", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "badge", "type" : "String", "desc" : "text for badge", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "images", "type" : "Array", "desc" : "an array of ?? Img objects ??? when loading existing files..", - "memberOf" : "Roo.bootstrap.ButtonUploader", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "disabled", "type" : "Boolean", "desc" : "default false;", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "weight", "type" : "String", "desc" : "k) default", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "default", - "primary", - "secondary", - "success", - "info", - "warning", - "danger", - "link", - "light", - "dark" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "grpup", "type" : "Boolean", "desc" : "if parent is a btn group - then it turns it into a toogleGroup.", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "ontext", "type" : "String", "desc" : "text for on slidy toggle state", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "preventDefault", "type" : "Boolean", "desc" : "default true (stop click event triggering the URL if it's a link.)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "theme", "type" : "String", "desc" : "w)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "default", - "glow" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "target", "type" : "String", "desc" : "r) target for a href.", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "_self", - "_blank", - "_parent", - "_top", - "other" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "glyphicon", "type" : "String", "desc" : "depricated - use fa", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "isClose", "type" : "Boolean", "desc" : "default false;", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "errorTimeout", "type" : "Number", "desc" : "default 3000", - "memberOf" : "Roo.bootstrap.ButtonUploader", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "fa", "type" : "String", "desc" : "fontawesome icon - eg. 'comment' - without the fa/fas etc..", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "size", "type" : "String", "desc" : "s)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "lg", - "sm", - "xs" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "badge_weight", "type" : "String", "desc" : "k) default (same as button)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "default", - "primary", - "secondary", - "success", - "info", - "warning", - "danger", - "link", - "light", - "dark" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "multiple", "type" : "Boolean", "desc" : "(default true) Should the upload allow multiple files to be uploaded.", - "memberOf" : "Roo.bootstrap.ButtonUploader", - "optvals" : [] + "memberOf" : "" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "href", "type" : "String", "desc" : "empty or href", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "tag", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "a", - "input", - "submit" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "outline", "type" : "Boolean", "desc" : "default false (except for weight=default which emulates old behaveiour with an outline)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "offtext", "type" : "String", "desc" : "text for off slidy toggle state", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "removeClass", "type" : "Boolean", "desc" : "remove the standard class..", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "html", "type" : "Array", "desc" : "The button text.", - "memberOf" : "Roo.bootstrap.ButtonUploader", - "optvals" : [] + "memberOf" : "" }, { "name" : "pressed", "type" : "Boolean", "desc" : "default null - if the button ahs active state", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" } ], "methods" : [ { "name" : "reset", + "type" : "function", "desc" : "addCard - add an Attachment to the uploader", + "sig" : "(data)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ButtonUploader", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "data", @@ -368,29 +291,39 @@ }, { "name" : "setText", + "type" : "function", "desc" : "set the text of the first selected button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isActive", + "type" : "function", "desc" : "get the current active state", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -402,15 +335,20 @@ }, { "name" : "setActive", + "type" : "function", "desc" : "sets the active state on/off,", + "sig" : "(state)", + "static" : false, + "memberOf" : "Roo.bootstrap.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "state", @@ -423,71 +361,96 @@ }, { "name" : "toggleActive", + "type" : "function", "desc" : "toggles the current active state", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getText", + "type" : "function", "desc" : "get the text of the first selected button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "enable", + "type" : "function", "desc" : "Enables this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "disable", + "type" : "function", "desc" : "Disable this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Button", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -499,85 +462,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -589,15 +582,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -609,15 +607,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -630,43 +633,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -679,15 +697,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -706,15 +729,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -733,15 +761,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -753,29 +786,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -806,15 +849,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -839,15 +887,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -860,15 +913,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -881,15 +939,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -914,15 +977,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -947,15 +1015,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -974,15 +1047,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1007,15 +1085,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1048,8 +1131,10 @@ "events" : [ { "name" : "fired when files have been selected,", + "type" : "function", "desc" : "When a the download link is clicked", - "memberOf" : "Roo.bootstrap.ButtonUploader", + "sig" : "function (_self, Array)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1072,8 +1157,10 @@ }, { "name" : "beforeselect", + "type" : "function", "desc" : "When button is pressed, before show upload files dialog is shown", - "memberOf" : "Roo.bootstrap.ButtonUploader", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1090,7 +1177,9 @@ }, { "name" : "toggle", + "type" : "function", "desc" : "After the button has been toggles", + "sig" : "function (btn, e, pressed)\n{\n\n}", "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", @@ -1120,7 +1209,9 @@ }, { "name" : "dblclick", + "type" : "function", "desc" : "When a button is double clicked", + "sig" : "function (btn, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", @@ -1144,7 +1235,9 @@ }, { "name" : "click", + "type" : "function", "desc" : "When a button is pressed", + "sig" : "function (btn, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", @@ -1168,7 +1261,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1186,7 +1281,9 @@ }, { "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" : "", @@ -1204,7 +1301,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1222,7 +1321,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1240,7 +1341,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1258,7 +1361,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1276,7 +1381,9 @@ }, { "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" : "", @@ -1294,7 +1401,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1312,7 +1421,9 @@ }, { "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" : "", @@ -1330,7 +1441,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1348,7 +1461,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Calendar.json b/docs/symbols/Roo.bootstrap.Calendar.json index 91f6a91c74..21c9963497 100644 --- a/docs/symbols/Roo.bootstrap.Calendar.json +++ b/docs/symbols/Roo.bootstrap.Calendar.json @@ -23,148 +23,135 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "startDay", "type" : "Number", "desc" : "Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)", - "memberOf" : "Roo.bootstrap.Calendar", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" + }, + { + "name" : "store", + "type" : "Roo.data.Store", + "desc" : "The data source for the calendar", + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "loadMask", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Calendar", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "header", "type" : "Object", "desc" : "generate the user specific header of the calendar, default false", - "memberOf" : "Roo.bootstrap.Calendar", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -176,85 +163,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -266,15 +283,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -286,15 +308,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -307,43 +334,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -356,15 +398,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -383,15 +430,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -403,15 +455,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -430,15 +487,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -450,15 +512,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -470,29 +537,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -523,15 +600,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -556,15 +638,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -577,15 +664,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -598,15 +690,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -631,15 +728,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -664,15 +766,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -691,15 +798,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -724,15 +836,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -765,8 +882,10 @@ "events" : [ { "name" : "select", + "type" : "function", "desc" : "Fires when a date is selected", - "memberOf" : "Roo.bootstrap.Calendar", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -789,8 +908,10 @@ }, { "name" : "eventclick", + "type" : "function", "desc" : "Fires when the mouse click an", - "memberOf" : "Roo.bootstrap.Calendar", + "sig" : "function (_self, )\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -813,8 +934,10 @@ }, { "name" : "monthchange", + "type" : "function", "desc" : "Fires when the displayed month changes", - "memberOf" : "Roo.bootstrap.Calendar", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -837,8 +960,10 @@ }, { "name" : "evententer", + "type" : "function", "desc" : "Fires when mouse over an event", - "memberOf" : "Roo.bootstrap.Calendar", + "sig" : "function (_self, Event)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -861,8 +986,10 @@ }, { "name" : "eventleave", + "type" : "function", "desc" : "Fires when the mouse leaves an", - "memberOf" : "Roo.bootstrap.Calendar", + "sig" : "function (_self, )\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -885,7 +1012,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -903,7 +1032,9 @@ }, { "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" : "", @@ -921,7 +1052,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -939,7 +1072,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -957,7 +1092,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -975,7 +1112,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -993,7 +1132,9 @@ }, { "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" : "", @@ -1011,7 +1152,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1029,7 +1172,9 @@ }, { "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" : "", @@ -1047,7 +1192,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1065,7 +1212,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Card.json b/docs/symbols/Roo.bootstrap.Card.json index 814452e3ae..45f7796fdf 100644 --- a/docs/symbols/Roo.bootstrap.Card.json +++ b/docs/symbols/Roo.bootstrap.Card.json @@ -23,542 +23,336 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "header_size", "type" : "Number", "desc" : "5) H1 or H2 etc.. 0 indicates default", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5" - ] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "header_image", "type" : "String", "desc" : "src url of image.", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [] + "memberOf" : "" }, { "name" : "margin_right", "type" : "String", "desc" : "o)", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5", - "auto" - ] + "memberOf" : "" }, { "name" : "header", "type" : "String|Object", "desc" : "", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [] + "memberOf" : "" }, { "name" : "title", "type" : "String", "desc" : "", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "weight", "type" : "String", "desc" : "k)", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [ - "primary", - "warning", - "info", - "danger", - "secondary", - "success", - "light", - "dark" - ] + "memberOf" : "" }, { "name" : "display", "type" : "String", "desc" : "x)", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [ - "none", - "inline", - "inline-block", - "block", - "table", - "table-cell", - "table-row", - "flex", - "inline-flex" - ] + "memberOf" : "" }, { "name" : "margin_left", "type" : "String", "desc" : "o)", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5", - "auto" - ] + "memberOf" : "" }, { "name" : "padding_top", "type" : "String", "desc" : "5)next_to_card", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5" - ] + "memberOf" : "" }, { "name" : "subtitle", "type" : "String", "desc" : "", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [] + "memberOf" : "" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "padding_right", "type" : "String", "desc" : "5)", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5" - ] + "memberOf" : "" }, { "name" : "padding", "type" : "String", "desc" : "5)", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5" - ] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "header_weight", "type" : "Number", "desc" : "k)", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [ - "primary", - "secondary", - "success", - "info", - "warning", - "danger", - "light", - "dark" - ] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "display_xl", "type" : "String", "desc" : "x)", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [ - "none", - "inline", - "inline-block", - "block", - "table", - "table-cell", - "table-row", - "flex", - "inline-flex" - ] + "memberOf" : "" }, { "name" : "margin", "type" : "String", "desc" : "o)", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5", - "auto" - ] + "memberOf" : "" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "padding_bottom", "type" : "String", "desc" : "5)", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5" - ] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "display_lg", "type" : "String", "desc" : "x)", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [ - "none", - "inline", - "inline-block", - "block", - "table", - "table-cell", - "table-row", - "flex", - "inline-flex" - ] + "memberOf" : "" }, { "name" : "footer", "type" : "String", "desc" : "", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [] + "memberOf" : "" }, { "name" : "display_xs", "type" : "String", "desc" : "x)", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [ - "none", - "inline", - "inline-block", - "block", - "table", - "table-cell", - "table-row", - "flex", - "inline-flex" - ] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "margin_bottom", "type" : "String", "desc" : "o)", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5", - "auto" - ] + "memberOf" : "" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "margin_top", "type" : "String", "desc" : "o)", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5", - "auto" - ] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "padding_left", "type" : "String", "desc" : "5)", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5" - ] + "memberOf" : "" }, { "name" : "margin_x", "type" : "String", "desc" : "o)", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5", - "auto" - ] + "memberOf" : "" }, { "name" : "margin_y", "type" : "String", "desc" : "o)", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5", - "auto" - ] + "memberOf" : "" }, { "name" : "html", "type" : "String|Boolean", "desc" : "-- html contents - or just use children.. use false to hide it..", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [] + "memberOf" : "" }, { "name" : "padding_x", "type" : "String", "desc" : "5)", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5" - ] + "memberOf" : "" }, { "name" : "display_sm", "type" : "String", "desc" : "x)", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [ - "none", - "inline", - "inline-block", - "block", - "table", - "table-cell", - "table-row", - "flex", - "inline-flex" - ] + "memberOf" : "" }, { "name" : "padding_y", "type" : "String", "desc" : "5)", - "memberOf" : "Roo.bootstrap.Card", - "optvals" : [ - "0", - "1", - "2", - "3", - "4", - "5" - ] + "memberOf" : "" } ], "methods" : [ { "name" : "getDropPoint", + "type" : "function", "desc" : "Decide whether to drop above or below a View node.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Card", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getTargetFromEvent", + "type" : "function", "desc" : "Part of the Roo.dd.DropZone interface. If no target node is found, the\n whole Element becomes the target, and this causes the drop gesture to append.\n\n Returns an object:\n {\n \n position : 'below' or 'above'\n card : relateive to card OBJECT (or true for no cards listed)\n items_n : relative to nth item in list\n card_n : relative to nth card in list\n }", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Card", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "acceptCard", + "type" : "function", "desc" : "accept card\n\n- card.acceptCard(move_card, info.position, info.card, info.items_n);", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Card", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -570,85 +364,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -660,15 +484,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -680,15 +509,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -701,43 +535,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -750,15 +599,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -777,15 +631,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -797,15 +656,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -824,15 +688,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -844,15 +713,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -864,29 +738,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -917,15 +801,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -950,15 +839,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -971,15 +865,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -992,15 +891,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1025,15 +929,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1058,15 +967,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1085,15 +999,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1118,15 +1037,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1159,8 +1083,10 @@ "events" : [ { "name" : "rotate", + "type" : "function", "desc" : "When a element a card is rotate", - "memberOf" : "Roo.bootstrap.Card", + "sig" : "function (_self, n, rotate)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1189,8 +1115,10 @@ }, { "name" : "drop", + "type" : "function", "desc" : "When a element a card is dropped", - "memberOf" : "Roo.bootstrap.Card", + "sig" : "function (_self, move_card, position, next_to_card)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1225,8 +1153,10 @@ }, { "name" : "cardover", + "type" : "function", "desc" : "When a card element is dragged over ready to drop (return false to block dropable)", - "memberOf" : "Roo.bootstrap.Card", + "sig" : "function (_self, data)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1249,7 +1179,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1267,7 +1199,9 @@ }, { "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" : "", @@ -1285,7 +1219,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1303,7 +1239,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1321,7 +1259,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1339,7 +1279,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1357,7 +1299,9 @@ }, { "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" : "", @@ -1375,7 +1319,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1393,7 +1339,9 @@ }, { "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" : "", @@ -1411,7 +1359,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1429,7 +1379,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.CardFooter.json b/docs/symbols/Roo.bootstrap.CardFooter.json index 94aec66bda..c54150041b 100644 --- a/docs/symbols/Roo.bootstrap.CardFooter.json +++ b/docs/symbols/Roo.bootstrap.CardFooter.json @@ -24,165 +24,141 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "tag", "type" : "String", "desc" : "tag of the element", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "class of the element", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "html", "type" : "String", "desc" : "contents of the element", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "preventDefault", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "clickable", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "role", "type" : "String", "desc" : "default blank - set to button to force cursor pointer", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -194,85 +170,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -284,15 +290,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -304,15 +315,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -325,43 +341,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -374,15 +405,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -401,15 +437,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -421,15 +462,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -448,15 +494,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -468,15 +519,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -488,29 +544,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -541,15 +607,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -574,15 +645,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -595,15 +671,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -616,15 +697,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -649,15 +735,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -682,15 +773,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -709,15 +805,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -742,15 +843,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -783,7 +889,9 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "When a element is chick", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Element", "example" : "", "deprecated" : "", @@ -807,7 +915,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -825,7 +935,9 @@ }, { "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" : "", @@ -843,7 +955,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -861,7 +975,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -879,7 +995,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -897,7 +1015,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -915,7 +1035,9 @@ }, { "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" : "", @@ -933,7 +1055,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -951,7 +1075,9 @@ }, { "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" : "", @@ -969,7 +1095,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -987,7 +1115,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.CardHeader.json b/docs/symbols/Roo.bootstrap.CardHeader.json index dae393dd4c..b60cce9101 100644 --- a/docs/symbols/Roo.bootstrap.CardHeader.json +++ b/docs/symbols/Roo.bootstrap.CardHeader.json @@ -24,165 +24,141 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "tag", "type" : "String", "desc" : "tag of the element", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "html", "type" : "String", "desc" : "contents of the element", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "cls", "type" : "String", "desc" : "class of the element", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "preventDefault", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "clickable", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "role", "type" : "String", "desc" : "default blank - set to button to force cursor pointer", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -194,85 +170,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -284,15 +290,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -304,15 +315,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -325,43 +341,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -374,15 +405,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -401,15 +437,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -421,15 +462,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -448,15 +494,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -468,15 +519,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -488,29 +544,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -541,15 +607,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -574,15 +645,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -595,15 +671,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -616,15 +697,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -649,15 +735,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -682,15 +773,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -709,15 +805,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -742,15 +843,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -783,7 +889,9 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "When a element is chick", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Element", "example" : "", "deprecated" : "", @@ -807,7 +915,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -825,7 +935,9 @@ }, { "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" : "", @@ -843,7 +955,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -861,7 +975,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -879,7 +995,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -897,7 +1015,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -915,7 +1035,9 @@ }, { "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" : "", @@ -933,7 +1055,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -951,7 +1075,9 @@ }, { "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" : "", @@ -969,7 +1095,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -987,7 +1115,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.CardImageTop.json b/docs/symbols/Roo.bootstrap.CardImageTop.json index 4c33d1fd85..7e6a836f1d 100644 --- a/docs/symbols/Roo.bootstrap.CardImageTop.json +++ b/docs/symbols/Roo.bootstrap.CardImageTop.json @@ -24,165 +24,141 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "tag", "type" : "String", "desc" : "tag of the element", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "class of the element", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "html", "type" : "String", "desc" : "contents of the element", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "preventDefault", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "clickable", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "role", "type" : "String", "desc" : "default blank - set to button to force cursor pointer", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -194,85 +170,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -284,15 +290,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -304,15 +315,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -325,43 +341,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -374,15 +405,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -401,15 +437,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -421,15 +462,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -448,15 +494,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -468,15 +519,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -488,29 +544,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -541,15 +607,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -574,15 +645,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -595,15 +671,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -616,15 +697,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -649,15 +735,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -682,15 +773,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -709,15 +805,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -742,15 +843,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -783,7 +889,9 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "When a element is chick", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Element", "example" : "", "deprecated" : "", @@ -807,7 +915,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -825,7 +935,9 @@ }, { "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" : "", @@ -843,7 +955,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -861,7 +975,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -879,7 +995,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -897,7 +1015,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -915,7 +1035,9 @@ }, { "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" : "", @@ -933,7 +1055,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -951,7 +1075,9 @@ }, { "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" : "", @@ -969,7 +1095,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -987,7 +1115,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.CardUploader.json b/docs/symbols/Roo.bootstrap.CardUploader.json index 23c53b1150..b68172f496 100644 --- a/docs/symbols/Roo.bootstrap.CardUploader.json +++ b/docs/symbols/Roo.bootstrap.CardUploader.json @@ -24,331 +24,255 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "toggle", "type" : "Boolean", "desc" : "is it a slidy toggle button", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "inverse", "type" : "Boolean", "desc" : "dark themed version", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "badge", "type" : "String", "desc" : "text for badge", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "images", "type" : "Array", "desc" : "an array of ?? Img objects ??? when loading existing files..", - "memberOf" : "Roo.bootstrap.CardUploader", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "disabled", "type" : "Boolean", "desc" : "default false;", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "weight", "type" : "String", "desc" : "k) default", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "default", - "primary", - "secondary", - "success", - "info", - "warning", - "danger", - "link", - "light", - "dark" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "grpup", "type" : "Boolean", "desc" : "if parent is a btn group - then it turns it into a toogleGroup.", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "ontext", "type" : "String", "desc" : "text for on slidy toggle state", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "preventDefault", "type" : "Boolean", "desc" : "default true (stop click event triggering the URL if it's a link.)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "theme", "type" : "String", "desc" : "w)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "default", - "glow" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "target", "type" : "String", "desc" : "r) target for a href.", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "_self", - "_blank", - "_parent", - "_top", - "other" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "glyphicon", "type" : "String", "desc" : "depricated - use fa", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "isClose", "type" : "Boolean", "desc" : "default false;", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "errorTimeout", "type" : "Number", "desc" : "default 3000", - "memberOf" : "Roo.bootstrap.CardUploader", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "fa", "type" : "String", "desc" : "fontawesome icon - eg. 'comment' - without the fa/fas etc..", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "size", "type" : "String", "desc" : "s)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "lg", - "sm", - "xs" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "badge_weight", "type" : "String", "desc" : "k) default (same as button)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "default", - "primary", - "secondary", - "success", - "info", - "warning", - "danger", - "link", - "light", - "dark" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "href", "type" : "String", "desc" : "empty or href", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "tag", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [ - "a", - "input", - "submit" - ] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "outline", "type" : "Boolean", "desc" : "default false (except for weight=default which emulates old behaveiour with an outline)", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "offtext", "type" : "String", "desc" : "text for off slidy toggle state", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "removeClass", "type" : "Boolean", "desc" : "remove the standard class..", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" }, { "name" : "html", "type" : "Array", "desc" : "The button text.", - "memberOf" : "Roo.bootstrap.CardUploader", - "optvals" : [] + "memberOf" : "" }, { "name" : "pressed", "type" : "Boolean", "desc" : "default null - if the button ahs active state", - "memberOf" : "Roo.bootstrap.Button", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Button" } ], "methods" : [ { "name" : "addCard", + "type" : "function", "desc" : "addCard - add an Attachment to the uploader", + "sig" : "(data)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.CardUploader", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "data", @@ -361,29 +285,39 @@ }, { "name" : "setText", + "type" : "function", "desc" : "set the text of the first selected button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isActive", + "type" : "function", "desc" : "get the current active state", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -395,15 +329,20 @@ }, { "name" : "setActive", + "type" : "function", "desc" : "sets the active state on/off,", + "sig" : "(state)", + "static" : false, + "memberOf" : "Roo.bootstrap.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "state", @@ -416,71 +355,96 @@ }, { "name" : "toggleActive", + "type" : "function", "desc" : "toggles the current active state", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getText", + "type" : "function", "desc" : "get the text of the first selected button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "enable", + "type" : "function", "desc" : "Enables this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "disable", + "type" : "function", "desc" : "Disable this button", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Button", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Button", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -492,85 +456,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -582,15 +576,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -602,15 +601,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -623,43 +627,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -672,15 +691,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -699,15 +723,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -726,15 +755,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -746,29 +780,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -799,15 +843,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -832,15 +881,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -853,15 +907,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -874,15 +933,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -907,15 +971,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -940,15 +1009,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -967,15 +1041,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1000,15 +1079,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1041,8 +1125,10 @@ "events" : [ { "name" : "download", + "type" : "function", "desc" : "When a the download link is clicked", - "memberOf" : "Roo.bootstrap.CardUploader", + "sig" : "function (_self, The)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1065,8 +1151,10 @@ }, { "name" : "preview", + "type" : "function", "desc" : "When a image is clicked on - and needs to display a slideshow or similar..", - "memberOf" : "Roo.bootstrap.CardUploader", + "sig" : "function (_self, The)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1089,7 +1177,9 @@ }, { "name" : "toggle", + "type" : "function", "desc" : "After the button has been toggles", + "sig" : "function (btn, e, pressed)\n{\n\n}", "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", @@ -1119,7 +1209,9 @@ }, { "name" : "dblclick", + "type" : "function", "desc" : "When a button is double clicked", + "sig" : "function (btn, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", @@ -1143,7 +1235,9 @@ }, { "name" : "click", + "type" : "function", "desc" : "When a button is pressed", + "sig" : "function (btn, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Button", "example" : "", "deprecated" : "", @@ -1167,7 +1261,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1185,7 +1281,9 @@ }, { "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" : "", @@ -1203,7 +1301,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1221,7 +1321,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1239,7 +1341,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1257,7 +1361,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1275,7 +1381,9 @@ }, { "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" : "", @@ -1293,7 +1401,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1311,7 +1421,9 @@ }, { "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" : "", @@ -1329,7 +1441,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1347,7 +1461,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.CheckBox.json b/docs/symbols/Roo.bootstrap.CheckBox.json index 8b2c08b395..1a5e3fc9af 100644 --- a/docs/symbols/Roo.bootstrap.CheckBox.json +++ b/docs/symbols/Roo.bootstrap.CheckBox.json @@ -24,545 +24,447 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "validFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "lg", "type" : "Number", "desc" : "colspan out of 12 for large computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)", "type" : "String", "desc" : "inputType", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xs", "type" : "Number", "desc" : "colspan out of 12 for mobile-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "disabled", "type" : "Boolean", "desc" : "is it disabled", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "String", "desc" : "name of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "inputValue", "type" : "String", "desc" : "The value that should go into the generated input element's value when checked.", - "memberOf" : "Roo.bootstrap.CheckBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "weight", "type" : "String", "desc" : "s) The text that appears beside the checkbox", - "memberOf" : "Roo.bootstrap.CheckBox", - "optvals" : [ - "primary", - "warning", - "info", - "danger", - "success" - ] + "memberOf" : "" }, { "name" : "autocomplete", "type" : "String", "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "tooltip", "type" : "String", "desc" : "label tooltip", - "memberOf" : "Roo.bootstrap.CheckBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "regexText", "type" : "String", "desc" : "-- Depricated - use Invalid Text", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "boxLabel", "type" : "String", "desc" : "The text that appears beside the checkbox", - "memberOf" : "Roo.bootstrap.CheckBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "labelmd", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "value", "type" : "string", "desc" : "default value of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "sm", "type" : "Number", "desc" : "colspan out of 12 for tablet-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "groupId", "type" : "String", "desc" : "the checkbox group id // normal just use for checkbox", - "memberOf" : "Roo.bootstrap.CheckBox", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "Specifies that the field should be read-only", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "checked", "type" : "Boolean", "desc" : "initnal the element", - "memberOf" : "Roo.bootstrap.CheckBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "inline", "type" : "Boolean", "desc" : "inline the element (default false)", - "memberOf" : "Roo.bootstrap.CheckBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "size", "type" : "string", "desc" : "- (lg|sm) or leave empty..", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labellg", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelxs", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "invalidClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "fieldLabel", "type" : "string", "desc" : "- the label associated", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "before", "type" : "string", "desc" : "- input group add on before", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "invalidFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "placeholder", "type" : "string", "desc" : "- placeholder to put in text.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "md", "type" : "Number", "desc" : "colspan out of 12 for computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", "type" : "Number", "desc" : "set the width of label", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "valueOff", "type" : "String", "desc" : "The value that should go into the generated input element's value when unchecked.", - "memberOf" : "Roo.bootstrap.CheckBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "preventMark", "type" : "Boolean", "desc" : "Do not show tick or cross if error/success", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelsm", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "after", "type" : "string", "desc" : "- input group add on after", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" } ], "methods" : [ { "name" : "register", + "type" : "function", "desc" : "register a CheckBox Group", + "sig" : "(the)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.CheckBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -575,43 +477,58 @@ }, { "name" : "markValid", + "type" : "function", "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.CheckBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "inputEl", + "type" : "function", "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.CheckBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.CheckBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -624,15 +541,20 @@ }, { "name" : "get", + "type" : "function", "desc" : "fetch a CheckBox Group based on the group ID", + "sig" : "(the)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.CheckBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -645,29 +567,39 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -679,15 +611,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -699,15 +636,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -719,29 +661,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -753,15 +705,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -774,15 +731,20 @@ }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -795,15 +757,20 @@ }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -822,15 +789,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -842,85 +814,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -932,15 +934,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -952,15 +959,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -973,43 +985,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -1022,15 +1049,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -1049,15 +1081,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1069,15 +1106,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1096,15 +1138,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1116,15 +1163,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1136,29 +1188,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1189,15 +1251,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1222,15 +1289,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1243,15 +1315,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1264,15 +1341,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1297,15 +1379,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1330,15 +1417,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1357,15 +1449,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1390,15 +1487,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1431,8 +1533,10 @@ "events" : [ { "name" : "check", + "type" : "function", "desc" : "Fires when the element is checked or unchecked.", - "memberOf" : "Roo.bootstrap.CheckBox", + "sig" : "function (_self, checked)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1455,8 +1559,10 @@ }, { "name" : "click", + "type" : "function", "desc" : "Fires when the element is click.", - "memberOf" : "Roo.bootstrap.CheckBox", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1473,7 +1579,9 @@ }, { "name" : "paste", + "type" : "function", "desc" : "Fires after the user pastes into input", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1497,7 +1605,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1527,7 +1637,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1551,7 +1663,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1569,7 +1683,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1587,7 +1703,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1611,7 +1729,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1629,7 +1749,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1653,7 +1775,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1671,7 +1795,9 @@ }, { "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" : "", @@ -1689,7 +1815,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1707,7 +1835,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1725,7 +1855,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1743,7 +1875,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1761,7 +1895,9 @@ }, { "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" : "", @@ -1779,7 +1915,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1797,7 +1935,9 @@ }, { "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" : "", @@ -1815,7 +1955,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1833,7 +1975,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Column.json b/docs/symbols/Roo.bootstrap.Column.json index 6e2f577442..63274f5f44 100644 --- a/docs/symbols/Roo.bootstrap.Column.json +++ b/docs/symbols/Roo.bootstrap.Column.json @@ -23,242 +23,195 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "md", "type" : "Number", "desc" : "colspan out of 12 for computer-sized screens or 0 for hidden", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [] + "memberOf" : "" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "hidden", "type" : "Boolean", "desc" : "e) hide the element", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "lg", "type" : "Number", "desc" : "colspan out of 12 for large computer-sized screens or 0 for hidden", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "xs", "type" : "Number", "desc" : "colspan out of 12 for mobile-sized screens or 0 for hidden", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [] + "memberOf" : "" }, { "name" : "xsoff", "type" : "Number", "desc" : "colspan offset out of 12 for mobile-sized screens or 0 for hidden", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [] + "memberOf" : "" }, { "name" : "smoff", "type" : "Number", "desc" : "colspan offset out of 12 for tablet-sized screens or 0 for hidden", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [] + "memberOf" : "" }, { "name" : "mdoff", "type" : "Number", "desc" : "colspan offset out of 12 for computer-sized screens or 0 for hidden", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [] + "memberOf" : "" }, { "name" : "lgoff", "type" : "Number", "desc" : "colspan offset out of 12 for large computer-sized screens or 0 for hidden", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [] + "memberOf" : "" }, { "name" : "html", "type" : "String", "desc" : "content of column.", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "icon", "type" : "String", "desc" : ".) glyphicon name", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [ - "info-sign", - "check", - "..." - ] + "memberOf" : "" }, { "name" : "alert", "type" : "String", "desc" : "r) type alert (changes background / border...)", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [ - "success", - "info", - "warning", - "danger" - ] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "fa", "type" : "String", "desc" : ".) font awesome icon", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [ - "ban", - "check", - "..." - ] + "memberOf" : "" }, { "name" : "fasize", "type" : "Number", "desc" : ".) font awsome size", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [ - "1", - "2", - "...." - ] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "sm", "type" : "Number", "desc" : "colspan out of 12 for tablet-sized screens or 0 for hidden", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [] + "memberOf" : "" } ], "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -270,85 +223,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -360,15 +343,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -380,15 +368,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -401,43 +394,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -450,15 +458,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -477,15 +490,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -497,15 +515,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -524,15 +547,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -544,15 +572,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -564,29 +597,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -617,15 +660,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -650,15 +698,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -671,15 +724,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -692,15 +750,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -725,15 +788,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -758,15 +826,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -785,15 +858,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -818,15 +896,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -859,7 +942,9 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -877,7 +962,9 @@ }, { "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" : "", @@ -895,7 +982,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -913,7 +1002,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -931,7 +1022,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -949,7 +1042,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -967,7 +1062,9 @@ }, { "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" : "", @@ -985,7 +1082,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1003,7 +1102,9 @@ }, { "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" : "", @@ -1021,7 +1122,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1039,7 +1142,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.ComboBox.json b/docs/symbols/Roo.bootstrap.ComboBox.json index 8dfd137a44..1a463c0b75 100644 --- a/docs/symbols/Roo.bootstrap.ComboBox.json +++ b/docs/symbols/Roo.bootstrap.ComboBox.json @@ -25,916 +25,747 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "growMax", "type" : "Number", "desc" : "", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "md", "type" : "Number", "desc" : "colspan out of 12 for computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "grow", "type" : "Boolean", "desc" : "", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "queryDelay", "type" : "Number", "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "triggerAction", "type" : "String", "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "resizable", "type" : "Boolean", "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "mobileTouchView", "type" : "Boolean", "desc" : "e) show mobile touch view when using a mobile default true", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "labelmd", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "editable", "type" : "Boolean", "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "listWidth", "type" : "Number", "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "alwaysQuery", "type" : "Boolean", "desc" : "Disable caching of results, and always send query", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "handleHeight", "type" : "Number", "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "emptyResultText", "type" : "Boolean", "desc" : "only for touch device", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "title", "type" : "String", "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "after", "type" : "string", "desc" : "- input group add on after", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "name", "type" : "String", "desc" : "name of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "queryParam", "type" : "String", "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "tpl", "type" : "String/Roo.Template", "desc" : "The template to use to render the output default is '{' + this.displayField + '}'", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "selectedClass", "type" : "String", "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "autocomplete", "type" : "String", "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)", "type" : "String", "desc" : "inputType", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hiddenName", "type" : "String", "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "sm", "type" : "Number", "desc" : "colspan out of 12 for tablet-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "autoCreate", "type" : "Boolean/Object", "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "removable", "type" : "Boolean", "desc" : "e) special filter default false", - "memberOf" : "Roo.bootstrap.TriggerField", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.TriggerField" }, { "name" : "minChars", "type" : "Number", "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "animate", "type" : "Boolean", "desc" : "default true", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "btnPosition", "type" : "String", "desc" : "set the position of the trigger button (left | right) default right", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "disableClear", "type" : "Boolean", "desc" : "Disable showing of clear button.", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xs", "type" : "Number", "desc" : "colspan out of 12 for mobile-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "lazyRender", "type" : "Boolean", "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "labelsm", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelxs", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "listAlign", "type" : "String", "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "showToggleBtn", "type" : "Boolean", "desc" : "show toggle button or not (true|false) default true", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "invalidFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "triggerList", "type" : "Boolean", "desc" : "trigger show the list or not (true|false) default true", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "mode", "type" : "String", "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "typeAhead", "type" : "Boolean", "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "triggerText", "type" : "String", "desc" : "multiple combobox trigger button text default 'Select'", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "regexText", "type" : "String", "desc" : "-- Depricated - use Invalid Text", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "fieldLabel", "type" : "string", "desc" : "- the label associated", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "growMin", "type" : "Number", "desc" : "", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "disabled", "type" : "Boolean", "desc" : "is it disabled", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "triggerClass", "type" : "String", "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be appended if specified.", - "memberOf" : "Roo.bootstrap.TriggerField", - "optvals" : [] + "memberOf" : "Roo.bootstrap.TriggerField" }, { "name" : "validClass", "type" : "String", "desc" : "DEPRICATED - uses BS4 is-valid now", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "modalTitle", "type" : "String", "desc" : "The title of the dialog that pops up on mobile views.", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "preventMark", "type" : "Boolean", "desc" : "Do not show tick or cross if error/success", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "valueField", "type" : "String", "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "store", "type" : "Roo.data.Store", "desc" : "The data store to which this combo is bound (defaults to undefined)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "invalidClass", "type" : "String", "desc" : "DEPRICATED - uses BS4 is-valid now", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "listClass", "type" : "String", "desc" : "CSS class to apply to the dropdown list element (defaults to '')", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "displayField", "type" : "String", "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "tickable", "type" : "Boolean", "desc" : "ComboBox with tickable selections (true|false), default false", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "specialFilter", "type" : "Boolean", "desc" : "e) special filter default false", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "emptyTitle", "type" : "String", "desc" : "default ''", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "typeAheadDelay", "type" : "Number", "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "loadingText", "type" : "String", "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "size", "type" : "string", "desc" : "- (lg|sm) or leave empty..", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "width", "type" : "Number", "desc" : "fixed with? experimental", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "caret", "type" : "String", "desc" : "r) BS3 only - carat fa name", - "memberOf" : "Roo.bootstrap.TriggerField", - "optvals" : [ - "search", - "calendar" - ] + "memberOf" : "Roo.bootstrap.TriggerField" }, { "name" : "hideTrigger", "type" : "Boolean", "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", - "memberOf" : "Roo.bootstrap.TriggerField", - "optvals" : [] + "memberOf" : "Roo.bootstrap.TriggerField" }, { "name" : "minListWidth", "type" : "Number", "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "multiple", "type" : "Boolean", "desc" : "e) ComboBobArray, default false", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "placeholder", "type" : "string", "desc" : "- placeholder to put in text.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "before", "type" : "string", "desc" : "- input group add on before", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "Specifies that the field should be read-only", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxHeight", "type" : "Number", "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "mobile_restrict_height", "type" : "Boolean", "desc" : "e) restrict height for touch view", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "valueNotFoundText", "type" : "String", "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "validFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "autoFocus", "type" : "Boolean", "desc" : "e) auto focus the first item, default true", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "lg", "type" : "Number", "desc" : "colspan out of 12 for large computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "pageSize", "type" : "Number", "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "useNativeIOS", "type" : "Boolean", "desc" : "e) render it as classic select for ios, not support dynamic load data (default false)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "forceSelection", "type" : "Boolean", "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "labelWidth", "type" : "Number", "desc" : "set the width of label", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "append", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labellg", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allQuery", "type" : "String", "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "blockFocus", "type" : "Boolean", "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "shadow", "type" : "Boolean/String", "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "value", "type" : "string", "desc" : "default value of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" } ], "methods" : [ { "name" : "select", + "type" : "function", "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "sig" : "(index, scrollIntoView)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -953,43 +784,58 @@ }, { "name" : "expand", + "type" : "function", "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "collapse", + "type" : "function", "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the currently selected field value or empty string if no value is set.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1001,15 +847,20 @@ }, { "name" : "selectByValue", + "type" : "function", "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "sig" : "(value, scrollIntoView)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -1034,15 +885,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -1055,15 +911,20 @@ }, { "name" : "setFromData", + "type" : "function", "desc" : "Sets the value of the field based on a object which is related to the record format for the store.", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -1076,15 +937,20 @@ }, { "name" : "setEditable", + "type" : "function", "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -1097,43 +963,58 @@ }, { "name" : "clearValue", + "type" : "function", "desc" : "Clears any text/value currently set in the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isExpanded", + "type" : "function", "desc" : "Returns true if the dropdown list is expanded, else false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "doQuery", + "type" : "function", "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.", + "sig" : "(query, forceAll)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "query", @@ -1152,15 +1033,20 @@ }, { "name" : "onTriggerClick", + "type" : "function", "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.bootstrap.TriggerField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TriggerField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -1173,43 +1059,58 @@ }, { "name" : "autoSize", + "type" : "function", "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.TriggerField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TriggerField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1221,15 +1122,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -1242,15 +1148,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1262,29 +1173,39 @@ }, { "name" : "markValid", + "type" : "function", "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1296,29 +1217,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -1331,29 +1262,39 @@ }, { "name" : "inputEl", + "type" : "function", "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -1372,15 +1313,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1392,85 +1338,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1482,15 +1458,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1502,15 +1483,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -1523,43 +1509,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -1572,15 +1573,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -1599,15 +1605,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1619,15 +1630,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1646,15 +1662,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1666,15 +1687,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1686,29 +1712,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1739,15 +1775,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1772,15 +1813,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1793,15 +1839,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1814,15 +1865,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1847,15 +1903,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1880,15 +1941,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1907,15 +1973,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1940,15 +2011,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1981,8 +2057,10 @@ "events" : [ { "name" : "edit", + "type" : "function", "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)", - "memberOf" : "Roo.bootstrap.ComboBox", + "sig" : "function (combo, record)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -2005,8 +2083,10 @@ }, { "name" : "afterremove", + "type" : "function", "desc" : "Fires when the remove value from the combobox array", - "memberOf" : "Roo.bootstrap.ComboBox", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -2023,8 +2103,10 @@ }, { "name" : "touchviewdisplay", + "type" : "function", "desc" : "Fires when touch view require special display (default is using displayField)", - "memberOf" : "Roo.bootstrap.ComboBox", + "sig" : "function (combo, cfg)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -2047,8 +2129,10 @@ }, { "name" : "beforequery", + "type" : "function", "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:", - "memberOf" : "Roo.bootstrap.ComboBox", + "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -2089,8 +2173,10 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Fires when the remove value from the combobox array", - "memberOf" : "Roo.bootstrap.ComboBox", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -2107,8 +2193,10 @@ }, { "name" : "beforeselect", + "type" : "function", "desc" : "Fires before a list item is selected. Return false to cancel the selection.", - "memberOf" : "Roo.bootstrap.ComboBox", + "sig" : "function (combo, record, index)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -2137,8 +2225,10 @@ }, { "name" : "tick", + "type" : "function", "desc" : "Fires when tick the element", - "memberOf" : "Roo.bootstrap.ComboBox", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -2155,8 +2245,10 @@ }, { "name" : "add", + "type" : "function", "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)", - "memberOf" : "Roo.bootstrap.ComboBox", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -2173,8 +2265,10 @@ }, { "name" : "expand", + "type" : "function", "desc" : "Fires when the dropdown list is expanded", - "memberOf" : "Roo.bootstrap.ComboBox", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -2191,8 +2285,10 @@ }, { "name" : "specialfilter", + "type" : "function", "desc" : "Fires when specialfilter", - "memberOf" : "Roo.bootstrap.ComboBox", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -2209,8 +2305,10 @@ }, { "name" : "collapse", + "type" : "function", "desc" : "Fires when the dropdown list is collapsed", - "memberOf" : "Roo.bootstrap.ComboBox", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -2227,8 +2325,10 @@ }, { "name" : "select", + "type" : "function", "desc" : "Fires when a list item is selected", - "memberOf" : "Roo.bootstrap.ComboBox", + "sig" : "function (combo, record, index)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -2257,7 +2357,9 @@ }, { "name" : "paste", + "type" : "function", "desc" : "Fires after the user pastes into input", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -2281,7 +2383,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -2311,7 +2415,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -2335,7 +2441,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -2353,7 +2461,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -2371,7 +2481,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -2395,7 +2507,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -2413,7 +2527,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -2437,7 +2553,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -2455,7 +2573,9 @@ }, { "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" : "", @@ -2473,7 +2593,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2491,7 +2613,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2509,7 +2633,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2527,7 +2653,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2545,7 +2673,9 @@ }, { "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" : "", @@ -2563,7 +2693,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2581,7 +2713,9 @@ }, { "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" : "", @@ -2599,7 +2733,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2617,7 +2753,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Component.json b/docs/symbols/Roo.bootstrap.Component.json index 320dd17cd8..c95203ae64 100644 --- a/docs/symbols/Roo.bootstrap.Component.json +++ b/docs/symbols/Roo.bootstrap.Component.json @@ -22,124 +22,111 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -151,85 +138,115 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide a component - adds 'hidden' class", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Component", "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" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Component", "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" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Component", "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" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Component", "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" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Component", "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" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -241,15 +258,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -261,15 +283,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -282,43 +309,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -331,15 +373,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -358,15 +405,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -378,15 +430,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -405,15 +462,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -425,15 +487,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -445,29 +512,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -498,15 +575,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -531,15 +613,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -552,15 +639,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -573,15 +665,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -606,15 +703,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -639,15 +741,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -666,15 +773,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -699,15 +811,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -740,8 +857,10 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", - "memberOf" : "Roo.bootstrap.Component", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -758,7 +877,9 @@ }, { "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" : "", @@ -776,7 +897,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -794,7 +917,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -812,7 +937,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -830,7 +957,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -848,7 +977,9 @@ }, { "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" : "", @@ -866,7 +997,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -884,7 +1017,9 @@ }, { "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" : "", @@ -902,7 +1037,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -920,7 +1057,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Container.json b/docs/symbols/Roo.bootstrap.Container.json index b2c3e30c66..e3502a0fee 100644 --- a/docs/symbols/Roo.bootstrap.Container.json +++ b/docs/symbols/Roo.bootstrap.Container.json @@ -23,276 +23,207 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "panel", "type" : "String", "desc" : "r) render as panel - type - primary/success.....", - "memberOf" : "Roo.bootstrap.Container", - "optvals" : [ - "default", - "primary", - "success", - "info", - "warning", - "danger" - ] + "memberOf" : "" }, { "name" : "footer", "type" : "String", "desc" : "content of footer (for panel)", - "memberOf" : "Roo.bootstrap.Container", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "jumbotron", "type" : "Boolean", "desc" : "is it a jumbotron element", - "memberOf" : "Roo.bootstrap.Container", - "optvals" : [] + "memberOf" : "" }, { "name" : "sticky", "type" : "String", "desc" : "h) block to use as footer or body- needs css-bootstrap/sticky-footer.css", - "memberOf" : "Roo.bootstrap.Container", - "optvals" : [ - "footer", - "wrap", - "push" - ] + "memberOf" : "" }, { "name" : "hidden", "type" : "Boolean", "desc" : "e) hide the element", - "memberOf" : "Roo.bootstrap.Container", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "expanded", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Container", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "rheader", "type" : "String", "desc" : "contet on the right of header", - "memberOf" : "Roo.bootstrap.Container", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "tag", "type" : "String", "desc" : "n) type of HTML tag.", - "memberOf" : "Roo.bootstrap.Container", - "optvals" : [ - "header", - "aside", - "section" - ] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "well", "type" : "String", "desc" : "d) a well, large, small or medium.", - "memberOf" : "Roo.bootstrap.Container", - "optvals" : [ - "lg", - "sm", - "md" - ] + "memberOf" : "" }, { "name" : "html", "type" : "String", "desc" : "content of element", - "memberOf" : "Roo.bootstrap.Container", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "clickable", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Container", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "header", "type" : "String", "desc" : "content of header (for panel)", - "memberOf" : "Roo.bootstrap.Container", - "optvals" : [] + "memberOf" : "" }, { "name" : "icon", "type" : "String", "desc" : ".) glyphicon name", - "memberOf" : "Roo.bootstrap.Container", - "optvals" : [ - "info-sign", - "check", - "..." - ] + "memberOf" : "" }, { "name" : "expandable", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Container", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "alert", "type" : "String", "desc" : "r) type alert (changes background / border...)", - "memberOf" : "Roo.bootstrap.Container", - "optvals" : [ - "success", - "info", - "warning", - "danger" - ] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "fa", "type" : "String", "desc" : "font awesome icon", - "memberOf" : "Roo.bootstrap.Container", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -304,85 +235,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -394,15 +355,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -414,15 +380,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -435,43 +406,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -484,15 +470,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -511,15 +502,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -531,15 +527,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -558,15 +559,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -578,15 +584,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -598,29 +609,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -651,15 +672,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -684,15 +710,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -705,15 +736,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -726,15 +762,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -759,15 +800,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -792,15 +838,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -819,15 +870,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -852,15 +908,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -893,8 +954,10 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "When a element is chick", - "memberOf" : "Roo.bootstrap.Container", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -917,8 +980,10 @@ }, { "name" : "collapse", + "type" : "function", "desc" : "After the panel has been collapsed", - "memberOf" : "Roo.bootstrap.Container", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -935,8 +1000,10 @@ }, { "name" : "expand", + "type" : "function", "desc" : "After the panel has been expand", - "memberOf" : "Roo.bootstrap.Container", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -953,7 +1020,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -971,7 +1040,9 @@ }, { "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" : "", @@ -989,7 +1060,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1007,7 +1080,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1025,7 +1100,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1043,7 +1120,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1061,7 +1140,9 @@ }, { "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" : "", @@ -1079,7 +1160,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1097,7 +1180,9 @@ }, { "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" : "", @@ -1115,7 +1200,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1133,7 +1220,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.DateField.json b/docs/symbols/Roo.bootstrap.DateField.json index 25dc8a4beb..4ac363cef1 100644 --- a/docs/symbols/Roo.bootstrap.DateField.json +++ b/docs/symbols/Roo.bootstrap.DateField.json @@ -24,602 +24,508 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "validFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "lg", "type" : "Number", "desc" : "colspan out of 12 for large computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)", "type" : "String", "desc" : "inputType", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xs", "type" : "Number", "desc" : "colspan out of 12 for mobile-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "todayHighlight", "type" : "Boolean", "desc" : "default false", - "memberOf" : "Roo.bootstrap.DateField", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "disabled", "type" : "Boolean", "desc" : "is it disabled", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "String", "desc" : "name of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "autocomplete", "type" : "String", "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "regexText", "type" : "String", "desc" : "-- Depricated - use Invalid Text", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "altFormats", "type" : "String", "desc" : "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').", - "memberOf" : "Roo.bootstrap.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "viewMode", "type" : "String", "desc" : "default empty, (months|years)", - "memberOf" : "Roo.bootstrap.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "labelmd", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "singleMode", "type" : "Boolean", "desc" : "default false (true | false)", - "memberOf" : "Roo.bootstrap.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "value", "type" : "string", "desc" : "default value of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "daysOfWeekDisabled", "type" : "Object", "desc" : "default empty", - "memberOf" : "Roo.bootstrap.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "sm", "type" : "Number", "desc" : "colspan out of 12 for tablet-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "endDate", "type" : "Number", "desc" : "default Infinity", - "memberOf" : "Roo.bootstrap.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "Specifies that the field should be read-only", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "language", "type" : "String", "desc" : "default en", - "memberOf" : "Roo.bootstrap.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "size", "type" : "string", "desc" : "- (lg|sm) or leave empty..", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labellg", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelxs", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "keyboardNavigation", "type" : "Boolean", "desc" : "default true", - "memberOf" : "Roo.bootstrap.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "invalidClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "calendarWeeks", "type" : "Boolean", "desc" : "default false", - "memberOf" : "Roo.bootstrap.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "minViewMode", "type" : "String", "desc" : "default empty, (months|years)", - "memberOf" : "Roo.bootstrap.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "fieldLabel", "type" : "string", "desc" : "- the label associated", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "before", "type" : "string", "desc" : "- input group add on before", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "startDate", "type" : "Number", "desc" : "default -Infinity", - "memberOf" : "Roo.bootstrap.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "invalidFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "placeholder", "type" : "string", "desc" : "- placeholder to put in text.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "format", "type" : "String", "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').", - "memberOf" : "Roo.bootstrap.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "weekStart", "type" : "Number", "desc" : "default 0", - "memberOf" : "Roo.bootstrap.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "md", "type" : "Number", "desc" : "colspan out of 12 for computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", "type" : "Number", "desc" : "set the width of label", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "todayBtn", "type" : "Boolean", "desc" : "default false", - "memberOf" : "Roo.bootstrap.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "preventMark", "type" : "Boolean", "desc" : "Do not show tick or cross if error/success", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelsm", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "after", "type" : "string", "desc" : "- input group add on after", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" } ], "methods" : [ { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -631,15 +537,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -652,15 +563,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -672,29 +588,39 @@ }, { "name" : "markValid", + "type" : "function", "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -706,29 +632,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -740,15 +676,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -761,15 +702,20 @@ }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -782,29 +728,39 @@ }, { "name" : "inputEl", + "type" : "function", "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -823,15 +779,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -843,85 +804,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -933,15 +924,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -953,15 +949,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -974,43 +975,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -1023,15 +1039,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -1050,15 +1071,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1070,15 +1096,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1097,15 +1128,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1117,15 +1153,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1137,29 +1178,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1190,15 +1241,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1223,15 +1279,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1244,15 +1305,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1265,15 +1331,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1298,15 +1369,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1331,15 +1407,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1358,15 +1439,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1391,15 +1477,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1432,8 +1523,10 @@ "events" : [ { "name" : "beforeselect", + "type" : "function", "desc" : "Fires when before select a date.", - "memberOf" : "Roo.bootstrap.DateField", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1456,8 +1549,10 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires when this field show.", - "memberOf" : "Roo.bootstrap.DateField", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1480,8 +1575,10 @@ }, { "name" : "select", + "type" : "function", "desc" : "Fires when select a date.", - "memberOf" : "Roo.bootstrap.DateField", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1504,7 +1601,9 @@ }, { "name" : "paste", + "type" : "function", "desc" : "Fires after the user pastes into input", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1528,7 +1627,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1558,7 +1659,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1582,7 +1685,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1600,7 +1705,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1618,7 +1725,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1642,7 +1751,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1660,7 +1771,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1684,7 +1797,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1702,7 +1817,9 @@ }, { "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" : "", @@ -1720,7 +1837,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1738,7 +1857,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1756,7 +1877,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1774,7 +1897,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1792,7 +1917,9 @@ }, { "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" : "", @@ -1810,7 +1937,9 @@ }, { "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" : "", @@ -1828,7 +1957,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1846,7 +1977,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.DateSplitField.json b/docs/symbols/Roo.bootstrap.DateSplitField.json index f3127fbf19..735a234367 100644 --- a/docs/symbols/Roo.bootstrap.DateSplitField.json +++ b/docs/symbols/Roo.bootstrap.DateSplitField.json @@ -23,248 +23,207 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.DateSplitField", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "" }, { "name" : "labellg", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.DateSplitField", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "yearPlaceholder", "type" : "string", "desc" : "", - "memberOf" : "Roo.bootstrap.DateSplitField", - "optvals" : [] + "memberOf" : "" }, { "name" : "monthFormat", "type" : "string", "desc" : "default 'm'", - "memberOf" : "Roo.bootstrap.DateSplitField", - "optvals" : [] + "memberOf" : "" }, { "name" : "labelxs", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.DateSplitField", - "optvals" : [] + "memberOf" : "" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "fieldLabel", "type" : "string", "desc" : "- the label associated", - "memberOf" : "Roo.bootstrap.DateSplitField", - "optvals" : [] + "memberOf" : "" }, { "name" : "monthAllowBlank", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.DateSplitField", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "labelWidth", "type" : "Number", "desc" : "set the width of label (0-12)", - "memberOf" : "Roo.bootstrap.DateSplitField", - "optvals" : [] + "memberOf" : "" }, { "name" : "monthPlaceholder", "type" : "string", "desc" : "", - "memberOf" : "Roo.bootstrap.DateSplitField", - "optvals" : [] + "memberOf" : "" }, { "name" : "yearFormat", "type" : "string", "desc" : "default 'Y'", - "memberOf" : "Roo.bootstrap.DateSplitField", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "labelsm", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.DateSplitField", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dayAllowBlank", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.DateSplitField", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "yearAllowBlank", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.DateSplitField", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "dayPlaceholder", "type" : "string", "desc" : "", - "memberOf" : "Roo.bootstrap.DateSplitField", - "optvals" : [] + "memberOf" : "" }, { "name" : "labelmd", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.DateSplitField", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "dayFormat", "type" : "string", "desc" : "default 'd'", - "memberOf" : "Roo.bootstrap.DateSplitField", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.DateSplitField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -277,15 +236,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -297,85 +261,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -387,15 +381,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -407,15 +406,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -428,43 +432,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -477,15 +496,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -504,15 +528,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -524,15 +553,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -551,15 +585,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -571,15 +610,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -591,29 +635,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -644,15 +698,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -677,15 +736,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -698,15 +762,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -719,15 +788,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -752,15 +826,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -785,15 +864,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -812,15 +896,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -845,15 +934,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -886,8 +980,10 @@ "events" : [ { "name" : "days", + "type" : "function", "desc" : "getting the data of days", - "memberOf" : "Roo.bootstrap.DateSplitField", + "sig" : "function (_self, days)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -910,8 +1006,10 @@ }, { "name" : "years", + "type" : "function", "desc" : "getting the data of years", - "memberOf" : "Roo.bootstrap.DateSplitField", + "sig" : "function (_self, years)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -934,8 +1032,10 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", - "memberOf" : "Roo.bootstrap.DateSplitField", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -958,8 +1058,10 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", - "memberOf" : "Roo.bootstrap.DateSplitField", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -976,7 +1078,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -994,7 +1098,9 @@ }, { "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" : "", @@ -1012,7 +1118,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1030,7 +1138,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1048,7 +1158,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1066,7 +1178,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1084,7 +1198,9 @@ }, { "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" : "", @@ -1102,7 +1218,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1120,7 +1238,9 @@ }, { "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" : "", @@ -1138,7 +1258,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1156,7 +1278,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.DocumentManager.json b/docs/symbols/Roo.bootstrap.DocumentManager.json index b04e9e0284..6334cabde8 100644 --- a/docs/symbols/Roo.bootstrap.DocumentManager.json +++ b/docs/symbols/Roo.bootstrap.DocumentManager.json @@ -23,235 +23,201 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "labelAlign", "type" : "String", "desc" : "p) default left", - "memberOf" : "Roo.bootstrap.DocumentManager", - "optvals" : [ - "left", - "top" - ] + "memberOf" : "" }, { "name" : "labellg", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.DocumentManager", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "labelxs", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.DocumentManager", - "optvals" : [] + "memberOf" : "" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "fieldLabel", "type" : "String", "desc" : "", - "memberOf" : "Roo.bootstrap.DocumentManager", - "optvals" : [] + "memberOf" : "" }, { "name" : "toolTipName", "type" : "String", "desc" : "default 'filename'", - "memberOf" : "Roo.bootstrap.DocumentManager", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "method", "type" : "String", "desc" : "default POST", - "memberOf" : "Roo.bootstrap.DocumentManager", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "paramName", "type" : "String", "desc" : "default 'imageUpload'", - "memberOf" : "Roo.bootstrap.DocumentManager", - "optvals" : [] + "memberOf" : "" }, { "name" : "labelWidth", "type" : "Number", "desc" : "default 4", - "memberOf" : "Roo.bootstrap.DocumentManager", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "editable", "type" : "Boolean", "desc" : "e) allow edit when upload a image default true", - "memberOf" : "Roo.bootstrap.DocumentManager", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "labelsm", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.DocumentManager", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "boxes", "type" : "Number", "desc" : "number of boxes, 0 is no limit.. default 0", - "memberOf" : "Roo.bootstrap.DocumentManager", - "optvals" : [] + "memberOf" : "" }, { "name" : "multiple", "type" : "Boolean", "desc" : "multiple upload default true", - "memberOf" : "Roo.bootstrap.DocumentManager", - "optvals" : [] + "memberOf" : "" }, { "name" : "thumbSize", "type" : "Number", "desc" : "default 300", - "memberOf" : "Roo.bootstrap.DocumentManager", - "optvals" : [] + "memberOf" : "" }, { "name" : "labelmd", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.DocumentManager", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "url", "type" : "String", "desc" : "action url", - "memberOf" : "Roo.bootstrap.DocumentManager", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -263,85 +229,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -353,15 +349,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -373,15 +374,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -394,43 +400,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -443,15 +464,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -470,15 +496,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -490,15 +521,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -517,15 +553,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -537,15 +578,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -557,29 +603,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -610,15 +666,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -643,15 +704,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -664,15 +730,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -685,15 +756,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -718,15 +794,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -751,15 +832,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -778,15 +864,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -811,15 +902,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -852,8 +948,10 @@ "events" : [ { "name" : "refresh", + "type" : "function", "desc" : "Fire after refresh the file", - "memberOf" : "Roo.bootstrap.DocumentManager", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -870,8 +968,10 @@ }, { "name" : "afterupload", + "type" : "function", "desc" : "Fire when xhr load exception", - "memberOf" : "Roo.bootstrap.DocumentManager", + "sig" : "function (_self, xhr)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -894,8 +994,10 @@ }, { "name" : "beforeselectfile", + "type" : "function", "desc" : "Fire before select file", - "memberOf" : "Roo.bootstrap.DocumentManager", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -912,8 +1014,10 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Fire when remove the file", - "memberOf" : "Roo.bootstrap.DocumentManager", + "sig" : "function (_self, file)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -936,8 +1040,10 @@ }, { "name" : "process", + "type" : "function", "desc" : "Fire before process file", - "memberOf" : "Roo.bootstrap.DocumentManager", + "sig" : "function (_self, file)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -960,8 +1066,10 @@ }, { "name" : "inspect", + "type" : "function", "desc" : "inspect selected file", - "memberOf" : "Roo.bootstrap.DocumentManager", + "sig" : "function (_self, file)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -984,8 +1092,10 @@ }, { "name" : "initial", + "type" : "function", "desc" : "Fire when initial the DocumentManager", - "memberOf" : "Roo.bootstrap.DocumentManager", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1002,8 +1112,10 @@ }, { "name" : "exception", + "type" : "function", "desc" : "Fire when xhr load exception", - "memberOf" : "Roo.bootstrap.DocumentManager", + "sig" : "function (_self, xhr)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1026,8 +1138,10 @@ }, { "name" : "prepare", + "type" : "function", "desc" : "prepare the form data", - "memberOf" : "Roo.bootstrap.DocumentManager", + "sig" : "function (_self, formData)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1050,8 +1164,10 @@ }, { "name" : "click", + "type" : "function", "desc" : "Fire after click the image", - "memberOf" : "Roo.bootstrap.DocumentManager", + "sig" : "function (_self, file)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1074,8 +1190,10 @@ }, { "name" : "edit", + "type" : "function", "desc" : "Fire when upload a image and editable set to true", - "memberOf" : "Roo.bootstrap.DocumentManager", + "sig" : "function (_self, file)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1098,8 +1216,10 @@ }, { "name" : "previewrendered", + "type" : "function", "desc" : "Fire when preview rendered", - "memberOf" : "Roo.bootstrap.DocumentManager", + "sig" : "function (_self, file)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1122,7 +1242,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1140,7 +1262,9 @@ }, { "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" : "", @@ -1158,7 +1282,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1176,7 +1302,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1194,7 +1322,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1212,7 +1342,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1230,7 +1362,9 @@ }, { "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" : "", @@ -1248,7 +1382,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1266,7 +1402,9 @@ }, { "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" : "", @@ -1284,7 +1422,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1302,7 +1442,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.DocumentSlider.json b/docs/symbols/Roo.bootstrap.DocumentSlider.json index ab66356da2..78b6420cc4 100644 --- a/docs/symbols/Roo.bootstrap.DocumentSlider.json +++ b/docs/symbols/Roo.bootstrap.DocumentSlider.json @@ -23,124 +23,111 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -152,85 +139,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -242,15 +259,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -262,15 +284,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -283,43 +310,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -332,15 +374,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -359,15 +406,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -379,15 +431,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -406,15 +463,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -426,15 +488,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -446,29 +513,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -499,15 +576,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -532,15 +614,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -553,15 +640,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -574,15 +666,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -607,15 +704,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -640,15 +742,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -667,15 +774,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -700,15 +812,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -741,8 +858,10 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "Fire after click", - "memberOf" : "Roo.bootstrap.DocumentSlider", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -759,8 +878,10 @@ }, { "name" : "initial", + "type" : "function", "desc" : "Fire after initEvent", - "memberOf" : "Roo.bootstrap.DocumentSlider", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -777,8 +898,10 @@ }, { "name" : "update", + "type" : "function", "desc" : "Fire after update", - "memberOf" : "Roo.bootstrap.DocumentSlider", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -795,7 +918,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -813,7 +938,9 @@ }, { "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" : "", @@ -831,7 +958,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -849,7 +978,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -867,7 +998,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -885,7 +1018,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -903,7 +1038,9 @@ }, { "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" : "", @@ -921,7 +1058,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -939,7 +1078,9 @@ }, { "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" : "", @@ -957,7 +1098,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -975,7 +1118,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.DocumentViewer.json b/docs/symbols/Roo.bootstrap.DocumentViewer.json index 2e25881c6b..5c2e98c80e 100644 --- a/docs/symbols/Roo.bootstrap.DocumentViewer.json +++ b/docs/symbols/Roo.bootstrap.DocumentViewer.json @@ -23,144 +23,123 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "showTrash", "type" : "Boolean", "desc" : "e) show trash button (default true)", - "memberOf" : "Roo.bootstrap.DocumentViewer", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "showDownload", "type" : "Boolean", "desc" : "e) show download button (default true)", - "memberOf" : "Roo.bootstrap.DocumentViewer", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -172,85 +151,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -262,15 +271,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -282,15 +296,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -303,43 +322,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -352,15 +386,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -379,15 +418,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -399,15 +443,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -426,15 +475,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -446,15 +500,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -466,29 +525,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -519,15 +588,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -552,15 +626,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -573,15 +652,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -594,15 +678,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -627,15 +716,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -660,15 +754,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -687,15 +786,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -720,15 +824,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -761,8 +870,10 @@ "events" : [ { "name" : "download", + "type" : "function", "desc" : "Fire after download button", - "memberOf" : "Roo.bootstrap.DocumentViewer", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -779,8 +890,10 @@ }, { "name" : "initial", + "type" : "function", "desc" : "Fire after initEvent", - "memberOf" : "Roo.bootstrap.DocumentViewer", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -797,8 +910,10 @@ }, { "name" : "trash", + "type" : "function", "desc" : "Fire after trash button", - "memberOf" : "Roo.bootstrap.DocumentViewer", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -815,8 +930,10 @@ }, { "name" : "click", + "type" : "function", "desc" : "Fire after click", - "memberOf" : "Roo.bootstrap.DocumentViewer", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -833,7 +950,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -851,7 +970,9 @@ }, { "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" : "", @@ -869,7 +990,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -887,7 +1010,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -905,7 +1030,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -923,7 +1050,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -941,7 +1070,9 @@ }, { "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" : "", @@ -959,7 +1090,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -977,7 +1110,9 @@ }, { "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" : "", @@ -995,7 +1130,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1013,7 +1150,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.DropTarget.json b/docs/symbols/Roo.bootstrap.DropTarget.json index d922ed035b..01b0e51b1b 100644 --- a/docs/symbols/Roo.bootstrap.DropTarget.json +++ b/docs/symbols/Roo.bootstrap.DropTarget.json @@ -24,165 +24,141 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "tag", "type" : "String", "desc" : "tag of the element", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "class of the element", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "html", "type" : "String", "desc" : "contents of the element", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "preventDefault", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "clickable", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "dropable name", - "memberOf" : "Roo.bootstrap.DropTarget", - "optvals" : [] + "memberOf" : "" }, { "name" : "role", "type" : "String", "desc" : "default blank - set to button to force cursor pointer", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Element" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -194,85 +170,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -284,15 +290,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -304,15 +315,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -325,43 +341,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -374,15 +405,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -401,15 +437,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -421,15 +462,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -448,15 +494,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -468,15 +519,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -488,29 +544,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -541,15 +607,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -574,15 +645,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -595,15 +671,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -616,15 +697,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -649,15 +735,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -682,15 +773,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -709,15 +805,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -742,15 +843,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -783,8 +889,10 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "When a element is chick", - "memberOf" : "Roo.bootstrap.DropTarget", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -807,7 +915,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -825,7 +935,9 @@ }, { "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" : "", @@ -843,7 +955,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -861,7 +975,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -879,7 +995,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -897,7 +1015,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -915,7 +1035,9 @@ }, { "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" : "", @@ -933,7 +1055,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -951,7 +1075,9 @@ }, { "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" : "", @@ -969,7 +1095,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -987,7 +1115,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Element.json b/docs/symbols/Roo.bootstrap.Element.json index 7101483284..e88dca8d57 100644 --- a/docs/symbols/Roo.bootstrap.Element.json +++ b/docs/symbols/Roo.bootstrap.Element.json @@ -5,7 +5,7 @@ "Roo.Component", "Roo.util.Observable" ], - "desc" : "Bootstrap Element class", + "desc" : "Bootstrap Element class (basically a DIV used to make random stuff )", "isSingleton" : false, "isStatic" : false, "isBuiltin" : false, @@ -23,165 +23,141 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "tag", "type" : "String", "desc" : "tag of the element", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "class of the element", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [] + "memberOf" : "" }, { "name" : "html", "type" : "String", "desc" : "contents of the element", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [] + "memberOf" : "" }, { "name" : "preventDefault", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "clickable", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "role", "type" : "String", "desc" : "default blank - set to button to force cursor pointer", - "memberOf" : "Roo.bootstrap.Element", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -193,85 +169,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -283,15 +289,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -303,15 +314,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -324,43 +340,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -373,15 +404,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -400,15 +436,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -420,15 +461,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -447,15 +493,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -467,15 +518,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -487,29 +543,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -540,15 +606,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -573,15 +644,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -594,15 +670,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -615,15 +696,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -648,15 +734,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -681,15 +772,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -708,15 +804,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -741,15 +842,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -782,8 +888,10 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "When a element is chick", - "memberOf" : "Roo.bootstrap.Element", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -806,7 +914,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -824,7 +934,9 @@ }, { "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" : "", @@ -842,7 +954,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -860,7 +974,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -878,7 +994,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -896,7 +1014,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -914,7 +1034,9 @@ }, { "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" : "", @@ -932,7 +1054,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -950,7 +1074,9 @@ }, { "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" : "", @@ -968,7 +1094,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -986,7 +1114,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.FieldLabel.json b/docs/symbols/Roo.bootstrap.FieldLabel.json index 2b5dcf6a25..d0b8f13833 100644 --- a/docs/symbols/Roo.bootstrap.FieldLabel.json +++ b/docs/symbols/Roo.bootstrap.FieldLabel.json @@ -23,200 +23,178 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "validClass", "type" : "String", "desc" : "DEPRICATED - BS4 uses is-valid", - "memberOf" : "Roo.bootstrap.FieldLabel", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "tag", "type" : "String", "desc" : "tag of the element default label", - "memberOf" : "Roo.bootstrap.FieldLabel", - "optvals" : [] + "memberOf" : "" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.FieldLabel", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "class of the element", - "memberOf" : "Roo.bootstrap.FieldLabel", - "optvals" : [] + "memberOf" : "" }, { "name" : "html", "type" : "String", "desc" : "contents of the element", - "memberOf" : "Roo.bootstrap.FieldLabel", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "e) target allowBlank default true", - "memberOf" : "Roo.bootstrap.FieldLabel", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "invalidClass", "type" : "String", "desc" : "DEPRICATED - BS4 uses is-invalid", - "memberOf" : "Roo.bootstrap.FieldLabel", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "iconTooltip", "type" : "String", "desc" : "default \"This field is required\"", - "memberOf" : "Roo.bootstrap.FieldLabel", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "target", "type" : "String", "desc" : "label target", - "memberOf" : "Roo.bootstrap.FieldLabel", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "markValid", + "type" : "function", "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.FieldLabel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "get", + "type" : "function", "desc" : "fetch a FieldLabel Group based on the target", + "sig" : "(target)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.FieldLabel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -229,15 +207,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.FieldLabel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -250,15 +233,20 @@ }, { "name" : "register", + "type" : "function", "desc" : "register a FieldLabel Group", + "sig" : "(the)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.FieldLabel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -271,15 +259,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -291,85 +284,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -381,15 +404,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -401,15 +429,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -422,43 +455,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -471,15 +519,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -498,15 +551,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -518,15 +576,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -545,15 +608,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -565,15 +633,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -585,29 +658,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -638,15 +721,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -671,15 +759,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -692,15 +785,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -713,15 +811,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -746,15 +849,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -779,15 +887,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -806,15 +919,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -839,15 +957,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -880,8 +1003,10 @@ "events" : [ { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", - "memberOf" : "Roo.bootstrap.FieldLabel", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -904,8 +1029,10 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", - "memberOf" : "Roo.bootstrap.FieldLabel", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -922,7 +1049,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -940,7 +1069,9 @@ }, { "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" : "", @@ -958,7 +1089,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -976,7 +1109,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -994,7 +1129,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1012,7 +1149,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1030,7 +1169,9 @@ }, { "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" : "", @@ -1048,7 +1189,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1066,7 +1209,9 @@ }, { "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" : "", @@ -1084,7 +1229,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1102,7 +1249,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Form.json b/docs/symbols/Roo.bootstrap.Form.json index 2e2da14a0a..236cc8fb8f 100644 --- a/docs/symbols/Roo.bootstrap.Form.json +++ b/docs/symbols/Roo.bootstrap.Form.json @@ -23,204 +23,177 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "labelAlign", "type" : "String", "desc" : "top | left (default top)", - "memberOf" : "Roo.bootstrap.Form", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "fileUpload", "type" : "Boolean", "desc" : "Set to true if this form is a file upload.", - "memberOf" : "Roo.bootstrap.Form", - "optvals" : [] + "memberOf" : "" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "align", "type" : "String", "desc" : "left | right - for navbars", - "memberOf" : "Roo.bootstrap.Form", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "method", "type" : "String", "desc" : "GET | POST (default POST)", - "memberOf" : "Roo.bootstrap.Form", - "optvals" : [] + "memberOf" : "" }, { "name" : "errorMask", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Form", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "timeout", "type" : "Number", "desc" : "Timeout for form actions in seconds (default is 30 seconds).", - "memberOf" : "Roo.bootstrap.Form", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "loadMask", "type" : "Boolean", "desc" : "load mask when submit (default true)", - "memberOf" : "Roo.bootstrap.Form", - "optvals" : [] + "memberOf" : "" }, { "name" : "baseParams", "type" : "Object", "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.", - "memberOf" : "Roo.bootstrap.Form", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "maskBody", "type" : "Boolean", "desc" : "", - "memberOf" : "Roo.bootstrap.Form", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "url", "type" : "String", "desc" : "The URL to use for form actions if one isn't supplied in the action options.", - "memberOf" : "Roo.bootstrap.Form", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "maskOffset", "type" : "Number", "desc" : "Default 100", - "memberOf" : "Roo.bootstrap.Form", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "doAction", + "type" : "function", "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.", + "sig" : "(actionName, options)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Form", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "actionName", @@ -245,15 +218,20 @@ }, { "name" : "setValues", + "type" : "function", "desc" : "Set values for fields in this form in bulk.", + "sig" : "(values)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Form", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "values", @@ -272,15 +250,20 @@ }, { "name" : "getFieldValues", + "type" : "function", "desc" : "Returns the fields in this form as an object with key/value pairs.\nThis differs from getValues as it calls getValue on each child item, rather than using dom data.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Form", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -292,15 +275,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark fields in this form invalid in bulk.", + "sig" : "(errors)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Form", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "errors", @@ -319,15 +307,20 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clears all invalid messages in this form.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Form", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -339,15 +332,20 @@ }, { "name" : "findField", + "type" : "function", "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Form", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -366,15 +364,20 @@ }, { "name" : "isDirty", + "type" : "function", "desc" : "Returns true if any fields in this form have changed since their original load.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Form", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -386,15 +389,20 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets this form.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Form", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -406,15 +414,20 @@ }, { "name" : "getValues", + "type" : "function", "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.", + "sig" : "(asString)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Form", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "asString", @@ -433,15 +446,20 @@ }, { "name" : "isValid", + "type" : "function", "desc" : "Returns true if client-side validation on the form is successful.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Form", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -453,15 +471,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -473,85 +496,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -563,15 +616,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -583,15 +641,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -604,43 +667,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -653,15 +731,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -680,15 +763,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -700,15 +788,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -727,15 +820,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -747,15 +845,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -767,29 +870,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -820,15 +933,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -853,15 +971,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -874,15 +997,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -895,15 +1023,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -928,15 +1061,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -961,15 +1099,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -988,15 +1131,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1021,15 +1169,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1062,8 +1215,10 @@ "events" : [ { "name" : "actionfailed", + "type" : "function", "desc" : "Fires when an action fails.", - "memberOf" : "Roo.bootstrap.Form", + "sig" : "function (_self, action)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1086,8 +1241,10 @@ }, { "name" : "actioncomplete", + "type" : "function", "desc" : "Fires when an action is completed.", - "memberOf" : "Roo.bootstrap.Form", + "sig" : "function (_self, action)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1110,8 +1267,10 @@ }, { "name" : "beforeaction", + "type" : "function", "desc" : "Fires before any action is performed. Return false to cancel the action.", - "memberOf" : "Roo.bootstrap.Form", + "sig" : "function (_self, action)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1134,8 +1293,10 @@ }, { "name" : "clientvalidation", + "type" : "function", "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state", - "memberOf" : "Roo.bootstrap.Form", + "sig" : "function (_self, valid)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1158,7 +1319,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1176,7 +1339,9 @@ }, { "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" : "", @@ -1194,7 +1359,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1212,7 +1379,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1230,7 +1399,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1248,7 +1419,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1266,7 +1439,9 @@ }, { "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" : "", @@ -1284,7 +1459,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1302,7 +1479,9 @@ }, { "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" : "", @@ -1320,7 +1499,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1338,7 +1519,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Graph.json b/docs/symbols/Roo.bootstrap.Graph.json index 82417f58e9..91484294a2 100644 --- a/docs/symbols/Roo.bootstrap.Graph.json +++ b/docs/symbols/Roo.bootstrap.Graph.json @@ -23,173 +23,153 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "g_y", "type" : "number", "desc" : "coodinator | centre y (pie)", - "memberOf" : "Roo.bootstrap.Graph", - "optvals" : [] + "memberOf" : "" }, { "name" : "g_height", "type" : "number", "desc" : "height of the chart (respected by all elements in the set)", - "memberOf" : "Roo.bootstrap.Graph", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "g_r", "type" : "number", "desc" : "radius (pie)", - "memberOf" : "Roo.bootstrap.Graph", - "optvals" : [] + "memberOf" : "" }, { "name" : "title", "type" : "Object", "desc" : "The title of the chart\n \n -{Array} values\n -opts (object) options for the chart \n o {\n o type (string) type of endings of the bar. Default: 'square'. Other options are: 'round', 'sharp', 'soft'.\n o gutter (number)(string) default '20%' (WHAT DOES IT DO?)\n o vgutter (number)\n o colors (array) colors be used repeatedly to plot the bars. If multicolumn bar is used each sequence of bars with use a different color.\n o stacked (boolean) whether or not to tread values as in a stacked bar chart\n o to\n o stretch (boolean)\n o }\n -opts (object) options for the pie\n o{\n o cut\n o startAngle (number)\n o endAngle (number)\n }", - "memberOf" : "Roo.bootstrap.Graph", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "graphtype", "type" : "String", "desc" : "bar | vbar | pie", - "memberOf" : "Roo.bootstrap.Graph", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "g_width", "type" : "number", "desc" : "width of the chart (respected by all elements in the set)", - "memberOf" : "Roo.bootstrap.Graph", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "g_x", "type" : "number", "desc" : "coodinator | centre x (pie)", - "memberOf" : "Roo.bootstrap.Graph", - "optvals" : [] + "memberOf" : "" } ], "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -201,85 +181,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -291,15 +301,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -311,15 +326,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -332,43 +352,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -381,15 +416,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -408,15 +448,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -428,15 +473,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -455,15 +505,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -475,15 +530,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -495,29 +555,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -548,15 +618,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -581,15 +656,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -602,15 +682,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -623,15 +708,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -656,15 +746,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -689,15 +784,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -716,15 +816,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -749,15 +854,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -790,8 +900,10 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "The img click event for the img.", - "memberOf" : "Roo.bootstrap.Graph", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -808,7 +920,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -826,7 +940,9 @@ }, { "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" : "", @@ -844,7 +960,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -862,7 +980,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -880,7 +1000,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -898,7 +1020,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -916,7 +1040,9 @@ }, { "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" : "", @@ -934,7 +1060,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -952,7 +1080,9 @@ }, { "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" : "", @@ -970,7 +1100,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -988,7 +1120,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Header.json b/docs/symbols/Roo.bootstrap.Header.json index 8e37c8c3e1..05770cbb75 100644 --- a/docs/symbols/Roo.bootstrap.Header.json +++ b/docs/symbols/Roo.bootstrap.Header.json @@ -23,145 +23,123 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "level", "type" : "Number", "desc" : "6) default 1", - "memberOf" : "Roo.bootstrap.Header", - "optvals" : [ - "1", - "2", - "3", - "4", - "5", - "6" - ] + "memberOf" : "" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "html", "type" : "String", "desc" : "content of header", - "memberOf" : "Roo.bootstrap.Header", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -173,85 +151,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -263,15 +271,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -283,15 +296,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -304,43 +322,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -353,15 +386,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -380,15 +418,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -400,15 +443,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -427,15 +475,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -447,15 +500,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -467,29 +525,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -520,15 +588,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -553,15 +626,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -574,15 +652,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -595,15 +678,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -628,15 +716,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -661,15 +754,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -688,15 +786,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -721,15 +824,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -762,7 +870,9 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -780,7 +890,9 @@ }, { "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" : "", @@ -798,7 +910,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -816,7 +930,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -834,7 +950,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -852,7 +970,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -870,7 +990,9 @@ }, { "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" : "", @@ -888,7 +1010,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -906,7 +1030,9 @@ }, { "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" : "", @@ -924,7 +1050,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -942,7 +1070,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.HtmlEditor.json b/docs/symbols/Roo.bootstrap.HtmlEditor.json index 55aaceb560..3b3ca355eb 100644 --- a/docs/symbols/Roo.bootstrap.HtmlEditor.json +++ b/docs/symbols/Roo.bootstrap.HtmlEditor.json @@ -25,556 +25,453 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "validFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "lg", "type" : "Number", "desc" : "colspan out of 12 for large computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)", "type" : "String", "desc" : "inputType", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xs", "type" : "Number", "desc" : "colspan out of 12 for mobile-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "disabled", "type" : "Boolean", "desc" : "is it disabled", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "name", "type" : "String", "desc" : "name of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "resizable", "type" : "String", "desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.", - "memberOf" : "Roo.bootstrap.HtmlEditor", - "optvals" : [] + "memberOf" : "" }, { "name" : "toolbars", "type" : "Array", "desc" : "Array of toolbars. - defaults to just the Standard one", - "memberOf" : "Roo.bootstrap.HtmlEditor", - "optvals" : [] + "memberOf" : "" }, { "name" : "width", "type" : "Number", "desc" : "(in pixels)", - "memberOf" : "Roo.bootstrap.HtmlEditor", - "optvals" : [] + "memberOf" : "" }, { "name" : "autocomplete", "type" : "String", "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "regexText", "type" : "String", "desc" : "-- Depricated - use Invalid Text", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "height", "type" : "Number", "desc" : "(in pixels)", - "memberOf" : "Roo.bootstrap.HtmlEditor", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "labelmd", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "value", "type" : "string", "desc" : "default value of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "sm", "type" : "Number", "desc" : "colspan out of 12 for tablet-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "Specifies that the field should be read-only", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "wrap", "type" : "string", "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a form", - "memberOf" : "Roo.bootstrap.TextArea", - "optvals" : [ - "soft", - "hard" - ] + "memberOf" : "Roo.bootstrap.TextArea" }, { "name" : "size", "type" : "string", "desc" : "- (lg|sm) or leave empty..", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labellg", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "buttons", "type" : "Array", "desc" : "Array of toolbar's buttons. - defaults to empty", - "memberOf" : "Roo.bootstrap.HtmlEditor", - "optvals" : [] + "memberOf" : "" }, { "name" : "rows", "type" : "Number", "desc" : "Specifies the visible number of lines in a text area", - "memberOf" : "Roo.bootstrap.TextArea", - "optvals" : [] + "memberOf" : "Roo.bootstrap.TextArea" }, { "name" : "labelxs", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "invalidClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "fieldLabel", "type" : "string", "desc" : "- the label associated", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "cols", "type" : "Number", "desc" : "Specifies the visible width of a text area", - "memberOf" : "Roo.bootstrap.TextArea", - "optvals" : [] + "memberOf" : "Roo.bootstrap.TextArea" }, { "name" : "before", "type" : "string", "desc" : "- input group add on before", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "invalidFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "stylesheets", "type" : "Array", "desc" : "url of stylesheets. set to [] to disable stylesheets.", - "memberOf" : "Roo.bootstrap.HtmlEditor", - "optvals" : [] + "memberOf" : "" }, { "name" : "resize", "type" : "string", "desc" : "l)", - "memberOf" : "Roo.bootstrap.TextArea", - "optvals" : [ - "none", - "both", - "horizontal", - "vertical", - "inherit", - "initial" - ] + "memberOf" : "Roo.bootstrap.TextArea" }, { "name" : "placeholder", "type" : "string", "desc" : "- placeholder to put in text.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "md", "type" : "Number", "desc" : "colspan out of 12 for computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", "type" : "Number", "desc" : "set the width of label", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "html", "type" : "string", "desc" : "text", - "memberOf" : "Roo.bootstrap.TextArea", - "optvals" : [] + "memberOf" : "Roo.bootstrap.TextArea" }, { "name" : "preventMark", "type" : "Boolean", "desc" : "Do not show tick or cross if error/success", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelsm", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "after", "type" : "string", "desc" : "- input group add on after", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" } ], "methods" : [ { "name" : "toggleSourceEdit", + "type" : "function", "desc" : "Toggles the editor between standard and source edit mode.", + "sig" : "(sourceEdit)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.HtmlEditor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sourceEdit", @@ -587,15 +484,20 @@ }, { "name" : "createToolbar", + "type" : "function", "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.", + "sig" : "(editor)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.HtmlEditor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "editor", @@ -608,29 +510,39 @@ }, { "name" : "inputEl", + "type" : "function", "desc" : "return the real textarea element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.TextArea", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TextArea", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.bootstrap.TextArea", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TextArea", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -643,43 +555,58 @@ }, { "name" : "markValid", + "type" : "function", "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.TextArea", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TextArea", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.TextArea", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TextArea", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -691,15 +618,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -711,15 +643,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -731,29 +668,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -765,15 +712,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -786,15 +738,20 @@ }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -807,15 +764,20 @@ }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -834,15 +796,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -854,85 +821,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -944,15 +941,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -964,15 +966,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -985,43 +992,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -1034,15 +1056,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -1061,15 +1088,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1081,15 +1113,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1108,15 +1145,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1128,15 +1170,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1148,29 +1195,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1201,15 +1258,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1234,15 +1296,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1255,15 +1322,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1276,15 +1348,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1309,15 +1386,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1342,15 +1424,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1369,15 +1456,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1402,15 +1494,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1443,8 +1540,10 @@ "events" : [ { "name" : "initialize", + "type" : "function", "desc" : "Fires when the editor is fully initialized (including the iframe)", - "memberOf" : "Roo.bootstrap.HtmlEditor", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1461,8 +1560,10 @@ }, { "name" : "beforesync", + "type" : "function", "desc" : "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync.", - "memberOf" : "Roo.bootstrap.HtmlEditor", + "sig" : "function (_self, html)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1485,8 +1586,10 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "", - "memberOf" : "Roo.bootstrap.HtmlEditor", + "sig" : "function ()\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1496,8 +1599,10 @@ }, { "name" : "push", + "type" : "function", "desc" : "Fires when the iframe editor is updated with content from the textarea.", - "memberOf" : "Roo.bootstrap.HtmlEditor", + "sig" : "function (_self, html)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1520,8 +1625,10 @@ }, { "name" : "focus", + "type" : "function", "desc" : "", - "memberOf" : "Roo.bootstrap.HtmlEditor", + "sig" : "function ()\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1531,8 +1638,10 @@ }, { "name" : "editorevent", + "type" : "function", "desc" : "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.", - "memberOf" : "Roo.bootstrap.HtmlEditor", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1549,8 +1658,10 @@ }, { "name" : "sync", + "type" : "function", "desc" : "Fires when the textarea is updated with content from the editor iframe.", - "memberOf" : "Roo.bootstrap.HtmlEditor", + "sig" : "function (_self, html)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1573,8 +1684,10 @@ }, { "name" : "autosave", + "type" : "function", "desc" : "Auto save the htmlEditor value as a file into Events", - "memberOf" : "Roo.bootstrap.HtmlEditor", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1591,8 +1704,10 @@ }, { "name" : "change", + "type" : "function", "desc" : "", - "memberOf" : "Roo.bootstrap.HtmlEditor", + "sig" : "function ()\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1602,8 +1717,10 @@ }, { "name" : "savedpreview", + "type" : "function", "desc" : "preview the saved version of htmlEditor", - "memberOf" : "Roo.bootstrap.HtmlEditor", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1620,8 +1737,10 @@ }, { "name" : "blur", + "type" : "function", "desc" : "", - "memberOf" : "Roo.bootstrap.HtmlEditor", + "sig" : "function ()\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1631,8 +1750,10 @@ }, { "name" : "editmodechange", + "type" : "function", "desc" : "Fires when the editor switches edit modes", - "memberOf" : "Roo.bootstrap.HtmlEditor", + "sig" : "function (_self, sourceEdit)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1655,8 +1776,10 @@ }, { "name" : "firstfocus", + "type" : "function", "desc" : "Fires when on first focus - needed by toolbars..", - "memberOf" : "Roo.bootstrap.HtmlEditor", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1673,8 +1796,10 @@ }, { "name" : "beforepush", + "type" : "function", "desc" : "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push.", - "memberOf" : "Roo.bootstrap.HtmlEditor", + "sig" : "function (_self, html)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1697,8 +1822,10 @@ }, { "name" : "activate", + "type" : "function", "desc" : "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event.", - "memberOf" : "Roo.bootstrap.HtmlEditor", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1715,7 +1842,9 @@ }, { "name" : "paste", + "type" : "function", "desc" : "Fires after the user pastes into input", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1739,7 +1868,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1763,7 +1894,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1781,7 +1914,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1805,7 +1940,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1823,7 +1960,9 @@ }, { "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" : "", @@ -1841,7 +1980,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1859,7 +2000,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1877,7 +2020,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1895,7 +2040,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1913,7 +2060,9 @@ }, { "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" : "", @@ -1931,7 +2080,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1949,7 +2100,9 @@ }, { "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" : "", @@ -1967,7 +2120,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1985,7 +2140,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Img.json b/docs/symbols/Roo.bootstrap.Img.json index 864c1d7caa..3cc1e974d8 100644 --- a/docs/symbols/Roo.bootstrap.Img.json +++ b/docs/symbols/Roo.bootstrap.Img.json @@ -23,206 +23,177 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "src", "type" : "String", "desc" : "image source", - "memberOf" : "Roo.bootstrap.Img", - "optvals" : [] + "memberOf" : "" }, { "name" : "border", "type" : "String", "desc" : "rounded | circle | thumbnail", - "memberOf" : "Roo.bootstrap.Img", - "optvals" : [] + "memberOf" : "" }, { "name" : "xsUrl", "type" : "String", "desc" : "xs image source", - "memberOf" : "Roo.bootstrap.Img", - "optvals" : [] + "memberOf" : "" }, { "name" : "smUrl", "type" : "String", "desc" : "sm image source", - "memberOf" : "Roo.bootstrap.Img", - "optvals" : [] + "memberOf" : "" }, { "name" : "mdUrl", "type" : "String", "desc" : "md image source", - "memberOf" : "Roo.bootstrap.Img", - "optvals" : [] + "memberOf" : "" }, { "name" : "lgUrl", "type" : "String", "desc" : "lg image source", - "memberOf" : "Roo.bootstrap.Img", - "optvals" : [] + "memberOf" : "" }, { "name" : "backgroundContain", "type" : "Boolean", "desc" : "(use style background and contain image in content)", - "memberOf" : "Roo.bootstrap.Img", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "imgResponsive", "type" : "Boolean", "desc" : "false | true", - "memberOf" : "Roo.bootstrap.Img", - "optvals" : [] + "memberOf" : "" }, { "name" : "alt", "type" : "String", "desc" : "image alternative text", - "memberOf" : "Roo.bootstrap.Img", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "target", "type" : "String", "desc" : "p)target for a href.", - "memberOf" : "Roo.bootstrap.Img", - "optvals" : [ - "_self", - "_blank", - "_parent", - "_top" - ] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "href", "type" : "String", "desc" : "a tag href", - "memberOf" : "Roo.bootstrap.Img", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "setSrc", + "type" : "function", "desc" : "Sets the url of the image - used to update it", + "sig" : "(url)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Img", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "url", @@ -235,15 +206,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -255,85 +231,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -345,15 +351,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -365,15 +376,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -386,43 +402,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -435,15 +466,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -462,15 +498,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -482,15 +523,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -509,15 +555,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -529,15 +580,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -549,29 +605,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -602,15 +668,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -635,15 +706,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -656,15 +732,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -677,15 +758,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -710,15 +796,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -743,15 +834,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -770,15 +866,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -803,15 +904,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -844,8 +950,10 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "The img click event for the img.", - "memberOf" : "Roo.bootstrap.Img", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -862,8 +970,10 @@ }, { "name" : "load", + "type" : "function", "desc" : "The when any image loads", - "memberOf" : "Roo.bootstrap.Img", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -880,7 +990,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -898,7 +1010,9 @@ }, { "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" : "", @@ -916,7 +1030,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -934,7 +1050,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -952,7 +1070,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -970,7 +1090,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -988,7 +1110,9 @@ }, { "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" : "", @@ -1006,7 +1130,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1024,7 +1150,9 @@ }, { "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" : "", @@ -1042,7 +1170,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1060,7 +1190,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Input.json b/docs/symbols/Roo.bootstrap.Input.json index e8b98c2ef5..2413943bb4 100644 --- a/docs/symbols/Roo.bootstrap.Input.json +++ b/docs/symbols/Roo.bootstrap.Input.json @@ -23,504 +23,424 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "validFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "lg", "type" : "Number", "desc" : "colspan out of 12 for large computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "" }, { "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)", "type" : "String", "desc" : "inputType", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "xs", "type" : "Number", "desc" : "colspan out of 12 for mobile-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "disabled", "type" : "Boolean", "desc" : "is it disabled", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "String", "desc" : "name of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "autocomplete", "type" : "String", "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "regexText", "type" : "String", "desc" : "-- Depricated - use Invalid Text", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "labelmd", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "value", "type" : "string", "desc" : "default value of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "sm", "type" : "Number", "desc" : "colspan out of 12 for tablet-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "Specifies that the field should be read-only", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "" }, { "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "size", "type" : "string", "desc" : "- (lg|sm) or leave empty..", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "labellg", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "labelxs", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "invalidClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "fieldLabel", "type" : "string", "desc" : "- the label associated", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "before", "type" : "string", "desc" : "- input group add on before", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "invalidFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "placeholder", "type" : "string", "desc" : "- placeholder to put in text.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "md", "type" : "Number", "desc" : "colspan out of 12 for computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "labelWidth", "type" : "Number", "desc" : "set the width of label", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "" }, { "name" : "validClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "preventMark", "type" : "Boolean", "desc" : "Do not show tick or cross if error/success", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "labelsm", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "after", "type" : "string", "desc" : "- input group add on after", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -532,15 +452,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -553,15 +478,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -573,29 +503,39 @@ }, { "name" : "markValid", + "type" : "function", "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -607,29 +547,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -641,15 +591,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -662,15 +617,20 @@ }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -683,29 +643,39 @@ }, { "name" : "inputEl", + "type" : "function", "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -724,15 +694,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -744,85 +719,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -834,15 +839,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -854,15 +864,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -875,43 +890,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -924,15 +954,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -951,15 +986,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -971,15 +1011,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -998,15 +1043,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1018,15 +1068,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1038,29 +1093,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1091,15 +1156,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1124,15 +1194,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1145,15 +1220,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1166,15 +1246,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1199,15 +1284,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1232,15 +1322,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1259,15 +1354,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1292,15 +1392,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1333,8 +1438,10 @@ "events" : [ { "name" : "paste", + "type" : "function", "desc" : "Fires after the user pastes into input", - "memberOf" : "Roo.bootstrap.Input", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1357,8 +1464,10 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", - "memberOf" : "Roo.bootstrap.Input", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1387,8 +1496,10 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", - "memberOf" : "Roo.bootstrap.Input", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1411,8 +1522,10 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", - "memberOf" : "Roo.bootstrap.Input", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1429,8 +1542,10 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", - "memberOf" : "Roo.bootstrap.Input", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1447,8 +1562,10 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", - "memberOf" : "Roo.bootstrap.Input", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1471,8 +1588,10 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", - "memberOf" : "Roo.bootstrap.Input", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1489,8 +1608,10 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", - "memberOf" : "Roo.bootstrap.Input", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1513,7 +1634,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1531,7 +1654,9 @@ }, { "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" : "", @@ -1549,7 +1674,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1567,7 +1694,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1585,7 +1714,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1603,7 +1734,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1621,7 +1754,9 @@ }, { "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" : "", @@ -1639,7 +1774,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1657,7 +1794,9 @@ }, { "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" : "", @@ -1675,7 +1814,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1693,7 +1834,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.LayoutMasonry.json b/docs/symbols/Roo.bootstrap.LayoutMasonry.json index 03db3515cd..2177379a4a 100644 --- a/docs/symbols/Roo.bootstrap.LayoutMasonry.json +++ b/docs/symbols/Roo.bootstrap.LayoutMasonry.json @@ -23,187 +23,165 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "alternativePadWidth", "type" : "Number", "desc" : "padding below box..", - "memberOf" : "Roo.bootstrap.LayoutMasonry", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "maxCols", "type" : "Number", "desc" : "maximum number of columns", - "memberOf" : "Roo.bootstrap.LayoutMasonry", - "optvals" : [] + "memberOf" : "" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "isLayoutInstant", "type" : "Boolean", "desc" : "= no animation?", - "memberOf" : "Roo.bootstrap.LayoutMasonry", - "optvals" : [] + "memberOf" : "" }, { "name" : "boxWidth", "type" : "Number", "desc" : "width of the columns", - "memberOf" : "Roo.bootstrap.LayoutMasonry", - "optvals" : [] + "memberOf" : "" }, { "name" : "isHorizontal", "type" : "Boolean", "desc" : "defalut false", - "memberOf" : "Roo.bootstrap.LayoutMasonry", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "isAutoInitial", "type" : "Boolean", "desc" : "defalut true", - "memberOf" : "Roo.bootstrap.LayoutMasonry", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "padWidth", "type" : "Number", "desc" : "padding below box..", - "memberOf" : "Roo.bootstrap.LayoutMasonry", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "gutter", "type" : "Number", "desc" : "gutter width..", - "memberOf" : "Roo.bootstrap.LayoutMasonry", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "boxHeight", "type" : "Number", "desc" : "- 0 for square, or fix it at a certian height", - "memberOf" : "Roo.bootstrap.LayoutMasonry", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "removeBrick", + "type" : "function", "desc" : "remove a Masonry Brick", + "sig" : "(the)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.LayoutMasonry", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -216,15 +194,20 @@ }, { "name" : "_processVerticalLayoutQueue", + "type" : "function", "desc" : "Sets position of item in DOM", + "sig" : "(item, x, y, isInstant)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.LayoutMasonry", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "item", @@ -255,15 +238,20 @@ }, { "name" : "addBrick", + "type" : "function", "desc" : "adds a Masonry Brick", + "sig" : "(the)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.LayoutMasonry", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -276,15 +264,20 @@ }, { "name" : "register", + "type" : "function", "desc" : "register a Masonry Brick", + "sig" : "(the)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.LayoutMasonry", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -297,29 +290,39 @@ }, { "name" : "clearAll", + "type" : "function", "desc" : "clear all the Masonry Brick", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.LayoutMasonry", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "register", + "type" : "function", "desc" : "register a Masonry Layout", + "sig" : "(the)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.LayoutMasonry", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -332,15 +335,20 @@ }, { "name" : "get", + "type" : "function", "desc" : "fetch a Masonry Layout based on the masonry layout ID", + "sig" : "(the)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.LayoutMasonry", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -353,15 +361,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -373,85 +386,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -463,15 +506,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -483,15 +531,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -504,43 +557,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -553,15 +621,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -580,15 +653,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -600,15 +678,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -627,15 +710,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -647,15 +735,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -667,29 +760,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -720,15 +823,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -753,15 +861,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -774,15 +887,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -795,15 +913,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -828,15 +951,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -861,15 +989,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -888,15 +1021,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -921,15 +1059,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -962,8 +1105,10 @@ "events" : [ { "name" : "layout", + "type" : "function", "desc" : "Fire after layout the items", - "memberOf" : "Roo.bootstrap.LayoutMasonry", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -986,7 +1131,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1004,7 +1151,9 @@ }, { "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" : "", @@ -1022,7 +1171,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1040,7 +1191,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1058,7 +1211,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1076,7 +1231,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1094,7 +1251,9 @@ }, { "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" : "", @@ -1112,7 +1271,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1130,7 +1291,9 @@ }, { "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" : "", @@ -1148,7 +1311,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1166,7 +1331,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.LayoutMasonryAuto.json b/docs/symbols/Roo.bootstrap.LayoutMasonryAuto.json index 32dddcf95b..54622211f6 100644 --- a/docs/symbols/Roo.bootstrap.LayoutMasonryAuto.json +++ b/docs/symbols/Roo.bootstrap.LayoutMasonryAuto.json @@ -23,201 +23,184 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "isResizingContainer", "type" : "Boolean", "desc" : "= not sure if this is used..", - "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "maxCols", "type" : "Number", "desc" : "maximum number of columns", - "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", - "optvals" : [] + "memberOf" : "" }, { "name" : "isOriginLeft", "type" : "Boolean", "desc" : "= left align?", - "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", - "optvals" : [] + "memberOf" : "" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "isLayoutInstant", "type" : "Boolean", "desc" : "= no animation?", - "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", - "optvals" : [] + "memberOf" : "" }, { "name" : "padHeight", "type" : "Number", "desc" : "padding below box..", - "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "isAutoInitial", "type" : "Boolean", "desc" : "defalut true", - "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "columnWidth", "type" : "Number", "desc" : "width of the columns", - "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "isOriginTop", "type" : "Boolean", "desc" : "= top align?", - "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "isFitWidth", "type" : "Boolean", "desc" : "- resize the width..", - "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "_postLayout", + "type" : "function", "desc" : "Any logic you want to do after each layout,\ni.e. size the container", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "_processLayoutQueue", + "type" : "function", "desc" : "Sets position of item in DOM", + "sig" : "(item, x, y, isInstant)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "item", @@ -248,15 +231,20 @@ }, { "name" : "_getColGroup", + "type" : "function", "desc" : "", + "sig" : "(colSpan)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.LayoutMasonryAuto", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "colSpan", @@ -269,15 +257,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -289,85 +282,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -379,15 +402,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -399,15 +427,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -420,43 +453,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -469,15 +517,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -496,15 +549,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -516,15 +574,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -543,15 +606,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -563,15 +631,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -583,29 +656,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -636,15 +719,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -669,15 +757,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -690,15 +783,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -711,15 +809,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -744,15 +847,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -777,15 +885,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -804,15 +917,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -837,15 +955,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -878,7 +1001,9 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -896,7 +1021,9 @@ }, { "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" : "", @@ -914,7 +1041,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -932,7 +1061,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -950,7 +1081,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -968,7 +1101,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -986,7 +1121,9 @@ }, { "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" : "", @@ -1004,7 +1141,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1022,7 +1161,9 @@ }, { "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" : "", @@ -1040,7 +1181,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1058,7 +1201,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Link.json b/docs/symbols/Roo.bootstrap.Link.json index c42db06f27..f034c8fee5 100644 --- a/docs/symbols/Roo.bootstrap.Link.json +++ b/docs/symbols/Roo.bootstrap.Link.json @@ -5,7 +5,7 @@ "Roo.Component", "Roo.util.Observable" ], - "desc" : "Bootstrap Link Class", + "desc" : "Bootstrap Link Class (eg. '')", "isSingleton" : false, "isStatic" : false, "isBuiltin" : false, @@ -23,181 +23,153 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "anchor", "type" : "String", "desc" : "name for the anchor link", - "memberOf" : "Roo.bootstrap.Link", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "html", "type" : "String", "desc" : "the content of the link.", - "memberOf" : "Roo.bootstrap.Link", - "optvals" : [] + "memberOf" : "" }, { "name" : "preventDefault", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Link", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "alt", "type" : "String", "desc" : "image alternative text", - "memberOf" : "Roo.bootstrap.Link", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "target", "type" : "String", "desc" : "p) target for a href.", - "memberOf" : "Roo.bootstrap.Link", - "optvals" : [ - "_self", - "_blank", - "_parent", - "_top" - ] + "memberOf" : "" }, { "name" : "fa", "type" : "String", "desc" : "- favicon", - "memberOf" : "Roo.bootstrap.Link", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "href", "type" : "String", "desc" : "a tag href", - "memberOf" : "Roo.bootstrap.Link", - "optvals" : [] + "memberOf" : "" } ], "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -209,85 +181,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -299,15 +301,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -319,15 +326,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -340,43 +352,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -389,15 +416,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -416,15 +448,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -436,15 +473,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -463,15 +505,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -483,15 +530,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -503,29 +555,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -556,15 +618,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -589,15 +656,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -610,15 +682,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -631,15 +708,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -664,15 +746,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -697,15 +784,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -724,15 +816,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -757,15 +854,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -798,8 +900,10 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "The img click event for the img.", - "memberOf" : "Roo.bootstrap.Link", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -816,7 +920,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -834,7 +940,9 @@ }, { "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" : "", @@ -852,7 +960,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -870,7 +980,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -888,7 +1000,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -906,7 +1020,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -924,7 +1040,9 @@ }, { "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" : "", @@ -942,7 +1060,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -960,7 +1080,9 @@ }, { "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" : "", @@ -978,7 +1100,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -996,7 +1120,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.LocationPicker.json b/docs/symbols/Roo.bootstrap.LocationPicker.json index d823851889..052d62ce59 100644 --- a/docs/symbols/Roo.bootstrap.LocationPicker.json +++ b/docs/symbols/Roo.bootstrap.LocationPicker.json @@ -23,222 +23,195 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "streetViewControl", "type" : "Boolean", "desc" : "default false", - "memberOf" : "Roo.bootstrap.LocationPicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "disableDoubleClickZoom", "type" : "Boolean", "desc" : "default false", - "memberOf" : "Roo.bootstrap.LocationPicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "latitude", "type" : "Number", "desc" : "Position when init default 0", - "memberOf" : "Roo.bootstrap.LocationPicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "enableAutocomplete", "type" : "Boolean", "desc" : "default false", - "memberOf" : "Roo.bootstrap.LocationPicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "markerTitle", "type" : "String", "desc" : "", - "memberOf" : "Roo.bootstrap.LocationPicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "zoom", "type" : "Number", "desc" : "default 15", - "memberOf" : "Roo.bootstrap.LocationPicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "longitude", "type" : "Number", "desc" : "Position when init default 0", - "memberOf" : "Roo.bootstrap.LocationPicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "mapTypeControl", "type" : "Boolean", "desc" : "default false", - "memberOf" : "Roo.bootstrap.LocationPicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "radius", "type" : "Number", "desc" : "default 0", - "memberOf" : "Roo.bootstrap.LocationPicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "mapTypeId", "type" : "String", "desc" : "default google.maps.MapTypeId.ROADMAP", - "memberOf" : "Roo.bootstrap.LocationPicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "scrollwheel", "type" : "Boolean", "desc" : "default true", - "memberOf" : "Roo.bootstrap.LocationPicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "locationName", "type" : "String", "desc" : "", - "memberOf" : "Roo.bootstrap.LocationPicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "enableReverseGeocode", "type" : "Boolean", "desc" : "default true", - "memberOf" : "Roo.bootstrap.LocationPicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "draggable", "type" : "Boolean", "desc" : "default true", - "memberOf" : "Roo.bootstrap.LocationPicker", - "optvals" : [] + "memberOf" : "" } ], "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -250,85 +223,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -340,15 +343,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -360,15 +368,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -381,43 +394,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -430,15 +458,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -457,15 +490,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -477,15 +515,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -504,15 +547,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -524,15 +572,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -544,29 +597,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -597,15 +660,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -630,15 +698,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -651,15 +724,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -672,15 +750,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -705,15 +788,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -738,15 +826,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -765,15 +858,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -798,15 +896,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -839,8 +942,10 @@ "events" : [ { "name" : "mapRightClick", + "type" : "function", "desc" : "Fires when right click the map.", - "memberOf" : "Roo.bootstrap.LocationPicker", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -863,8 +968,10 @@ }, { "name" : "mapClick", + "type" : "function", "desc" : "Fires when click the map.", - "memberOf" : "Roo.bootstrap.LocationPicker", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -887,8 +994,10 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires when the map resize.", - "memberOf" : "Roo.bootstrap.LocationPicker", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -905,8 +1014,10 @@ }, { "name" : "OverlayViewOnRemove", + "type" : "function", "desc" : "Fires when OverlayView Draw", - "memberOf" : "Roo.bootstrap.LocationPicker", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -923,8 +1034,10 @@ }, { "name" : "OverlayViewDraw", + "type" : "function", "desc" : "Fires when OverlayView Draw", - "memberOf" : "Roo.bootstrap.LocationPicker", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -941,8 +1054,10 @@ }, { "name" : "OverlayViewOnAdd", + "type" : "function", "desc" : "Fires when OverlayView Draw", - "memberOf" : "Roo.bootstrap.LocationPicker", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -959,8 +1074,10 @@ }, { "name" : "OverlayViewHide", + "type" : "function", "desc" : "Fires when OverlayView Draw", - "memberOf" : "Roo.bootstrap.LocationPicker", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -977,8 +1094,10 @@ }, { "name" : "OverlayViewShow", + "type" : "function", "desc" : "Fires when OverlayView Draw", - "memberOf" : "Roo.bootstrap.LocationPicker", + "sig" : "function (_self, cpx)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1001,8 +1120,10 @@ }, { "name" : "initial", + "type" : "function", "desc" : "Fires when the picker initialized.", - "memberOf" : "Roo.bootstrap.LocationPicker", + "sig" : "function (_self, location)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1025,8 +1146,10 @@ }, { "name" : "positionchanged", + "type" : "function", "desc" : "Fires when the picker position changed.", - "memberOf" : "Roo.bootstrap.LocationPicker", + "sig" : "function (_self, location)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1049,8 +1172,10 @@ }, { "name" : "markerClick", + "type" : "function", "desc" : "Fires when click the marker.", - "memberOf" : "Roo.bootstrap.LocationPicker", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1073,8 +1198,10 @@ }, { "name" : "loadexception", + "type" : "function", "desc" : "Fires when load google lib failed.", - "memberOf" : "Roo.bootstrap.LocationPicker", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1091,8 +1218,10 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires when the map hide.", - "memberOf" : "Roo.bootstrap.LocationPicker", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1109,8 +1238,10 @@ }, { "name" : "markerRightClick", + "type" : "function", "desc" : "Fires when right click the marker.", - "memberOf" : "Roo.bootstrap.LocationPicker", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1133,8 +1264,10 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires when the map show.", - "memberOf" : "Roo.bootstrap.LocationPicker", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1151,7 +1284,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1169,7 +1304,9 @@ }, { "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" : "", @@ -1187,7 +1324,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1205,7 +1344,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1223,7 +1364,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1241,7 +1384,9 @@ }, { "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" : "", @@ -1259,7 +1404,9 @@ }, { "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" : "", @@ -1277,7 +1424,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1295,7 +1444,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Markdown.json b/docs/symbols/Roo.bootstrap.Markdown.json index dfd0d13d6d..7c6cd81cb7 100644 --- a/docs/symbols/Roo.bootstrap.Markdown.json +++ b/docs/symbols/Roo.bootstrap.Markdown.json @@ -18,556 +18,460 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "validFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "lg", "type" : "Number", "desc" : "colspan out of 12 for large computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)", "type" : "String", "desc" : "inputType", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xs", "type" : "Number", "desc" : "colspan out of 12 for mobile-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "disabled", "type" : "Boolean", "desc" : "is it disabled", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "name", "type" : "String", "desc" : "name of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "autocomplete", "type" : "String", "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "regexText", "type" : "String", "desc" : "-- Depricated - use Invalid Text", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "labelmd", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "value", "type" : "string", "desc" : "default value of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "sm", "type" : "Number", "desc" : "colspan out of 12 for tablet-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "Specifies that the field should be read-only", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "wrap", "type" : "string", "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a form", - "memberOf" : "Roo.bootstrap.TextArea", - "optvals" : [ - "soft", - "hard" - ] + "memberOf" : "Roo.bootstrap.TextArea" }, { "name" : "content", "type" : "string", "desc" : "", - "memberOf" : "Roo.bootstrap.Markdown", - "optvals" : [] + "memberOf" : "" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "size", "type" : "string", "desc" : "- (lg|sm) or leave empty..", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labellg", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "rows", "type" : "Number", "desc" : "Specifies the visible number of lines in a text area", - "memberOf" : "Roo.bootstrap.TextArea", - "optvals" : [] + "memberOf" : "Roo.bootstrap.TextArea" }, { "name" : "labelxs", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "invalidClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "fieldLabel", "type" : "string", "desc" : "- the label associated", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "cols", "type" : "Number", "desc" : "Specifies the visible width of a text area", - "memberOf" : "Roo.bootstrap.TextArea", - "optvals" : [] + "memberOf" : "Roo.bootstrap.TextArea" }, { "name" : "before", "type" : "string", "desc" : "- input group add on before", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "invalidFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "resize", "type" : "string", "desc" : "l)", - "memberOf" : "Roo.bootstrap.TextArea", - "optvals" : [ - "none", - "both", - "horizontal", - "vertical", - "inherit", - "initial" - ] + "memberOf" : "Roo.bootstrap.TextArea" }, { "name" : "placeholder", "type" : "string", "desc" : "- placeholder to put in text.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "md", "type" : "Number", "desc" : "colspan out of 12 for computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", "type" : "Number", "desc" : "set the width of label", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "html", "type" : "string", "desc" : "text", - "memberOf" : "Roo.bootstrap.TextArea", - "optvals" : [] + "memberOf" : "Roo.bootstrap.TextArea" }, { "name" : "preventMark", "type" : "Boolean", "desc" : "Do not show tick or cross if error/success", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelsm", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "after", "type" : "string", "desc" : "- input group add on after", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" } ], "methods" : [ { "name" : "inputEl", + "type" : "function", "desc" : "return the real textarea element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.TextArea", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TextArea", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.bootstrap.TextArea", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TextArea", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -580,43 +484,58 @@ }, { "name" : "markValid", + "type" : "function", "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.TextArea", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TextArea", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.TextArea", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TextArea", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -628,15 +547,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -648,15 +572,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -668,29 +597,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -702,15 +641,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -723,15 +667,20 @@ }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -744,15 +693,20 @@ }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -771,15 +725,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -791,85 +750,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -881,15 +870,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -901,15 +895,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -922,43 +921,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -971,15 +985,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -998,15 +1017,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1018,15 +1042,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1045,15 +1074,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1065,15 +1099,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1085,29 +1124,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1138,15 +1187,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1171,15 +1225,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1192,15 +1251,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1213,15 +1277,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1246,15 +1315,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1279,15 +1353,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1306,15 +1385,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1339,15 +1423,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1380,7 +1469,9 @@ "events" : [ { "name" : "paste", + "type" : "function", "desc" : "Fires after the user pastes into input", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1404,7 +1495,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1434,7 +1527,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1458,7 +1553,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1476,7 +1573,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1494,7 +1593,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1518,7 +1619,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1536,7 +1639,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1560,7 +1665,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1578,7 +1685,9 @@ }, { "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" : "", @@ -1596,7 +1705,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1614,7 +1725,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1632,7 +1745,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1650,7 +1765,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1668,7 +1785,9 @@ }, { "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" : "", @@ -1686,7 +1805,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1704,7 +1825,9 @@ }, { "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" : "", @@ -1722,7 +1845,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1740,7 +1865,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.MasonryBrick.json b/docs/symbols/Roo.bootstrap.MasonryBrick.json index 3fa142daa3..ca16588409 100644 --- a/docs/symbols/Roo.bootstrap.MasonryBrick.json +++ b/docs/symbols/Roo.bootstrap.MasonryBrick.json @@ -23,205 +23,171 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "placetitle", "type" : "String", "desc" : "m)", - "memberOf" : "Roo.bootstrap.MasonryBrick", - "optvals" : [ - "center", - "bottom" - ] + "memberOf" : "" }, { "name" : "inverse", "type" : "Boolean", "desc" : "defalut false", - "memberOf" : "Roo.bootstrap.MasonryBrick", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "title", "type" : "String", "desc" : "", - "memberOf" : "Roo.bootstrap.MasonryBrick", - "optvals" : [] + "memberOf" : "" }, { "name" : "videourl", "type" : "String", "desc" : "", - "memberOf" : "Roo.bootstrap.MasonryBrick", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "", - "memberOf" : "Roo.bootstrap.MasonryBrick", - "optvals" : [] + "memberOf" : "" }, { "name" : "html", "type" : "String", "desc" : "", - "memberOf" : "Roo.bootstrap.MasonryBrick", - "optvals" : [] + "memberOf" : "" }, { "name" : "preventDefault", "type" : "Boolean", "desc" : "defalut false", - "memberOf" : "Roo.bootstrap.MasonryBrick", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "size", "type" : "String", "desc" : "e)", - "memberOf" : "Roo.bootstrap.MasonryBrick", - "optvals" : [ - "xs", - "sm", - "md", - "md-left", - "md-right", - "tall", - "wide" - ] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "bgimage", "type" : "String", "desc" : "", - "memberOf" : "Roo.bootstrap.MasonryBrick", - "optvals" : [] + "memberOf" : "" }, { "name" : "isFitContainer", "type" : "Boolean", "desc" : "defalut true", - "memberOf" : "Roo.bootstrap.MasonryBrick", - "optvals" : [] + "memberOf" : "" }, { "name" : "href", "type" : "String", "desc" : "", - "memberOf" : "Roo.bootstrap.MasonryBrick", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "register", + "type" : "function", "desc" : "register a Masonry Brick", + "sig" : "(the)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.MasonryBrick", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -234,15 +200,20 @@ }, { "name" : "get", + "type" : "function", "desc" : "fetch a masonry brick based on the masonry brick ID", + "sig" : "(the)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.MasonryBrick", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -255,15 +226,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -275,85 +251,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -365,15 +371,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -385,15 +396,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -406,43 +422,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -455,15 +486,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -482,15 +518,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -502,15 +543,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -529,15 +575,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -549,15 +600,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -569,29 +625,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -622,15 +688,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -655,15 +726,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -676,15 +752,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -697,15 +778,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -730,15 +816,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -763,15 +854,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -790,15 +886,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -823,15 +924,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -864,8 +970,10 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "When a MasonryBrick is clcik", - "memberOf" : "Roo.bootstrap.MasonryBrick", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -888,7 +996,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -906,7 +1016,9 @@ }, { "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" : "", @@ -924,7 +1036,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -942,7 +1056,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -960,7 +1076,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -978,7 +1096,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -996,7 +1116,9 @@ }, { "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" : "", @@ -1014,7 +1136,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1032,7 +1156,9 @@ }, { "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" : "", @@ -1050,7 +1176,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1068,7 +1196,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Menu.json b/docs/symbols/Roo.bootstrap.Menu.json index 95e33a44d2..cf29ca1220 100644 --- a/docs/symbols/Roo.bootstrap.Menu.json +++ b/docs/symbols/Roo.bootstrap.Menu.json @@ -23,186 +23,153 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "isLink", "type" : "bool", "desc" : "e) the menu has link disable auto expand and collaspe (default false)", - "memberOf" : "Roo.bootstrap.Menu", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "align", "type" : "String", "desc" : "default tl-bl? == below - how the menu should be aligned.", - "memberOf" : "Roo.bootstrap.Menu", - "optvals" : [] + "memberOf" : "" }, { "name" : "hidden", "type" : "bool", "desc" : "if the menu should be hidden when rendered.", - "memberOf" : "Roo.bootstrap.Menu", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "stopEvent", "type" : "bool", "desc" : "e) Stop event after trigger press (default true)", - "memberOf" : "Roo.bootstrap.Menu", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "hideTrigger", "type" : "bool", "desc" : "e) default false - hide the carret for trigger.", - "memberOf" : "Roo.bootstrap.Menu", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "registerMenu", "type" : "Boolean", "desc" : "True (default) - means that clicking on screen etc. hides it.", - "memberOf" : "Roo.bootstrap.Menu", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "type", "type" : "String", "desc" : "u) type of menu", - "memberOf" : "Roo.bootstrap.Menu", - "optvals" : [ - "dropdown", - "treeview", - "submenu" - ] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "hide", + "type" : "function", "desc" : "Hides this menu and optionally all parent menus", + "sig" : "(deep)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "deep", @@ -215,15 +182,20 @@ }, { "name" : "showAt", + "type" : "function", "desc" : "Displays this menu at a specific xy position", + "sig" : "(xyPosition, parentMenu)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "xyPosition", @@ -242,15 +214,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Displays this menu relative to another element", + "sig" : "(element, position, parentMenu)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "element", @@ -275,15 +252,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -295,57 +277,77 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -357,15 +359,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -377,15 +384,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -398,43 +410,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -447,15 +474,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -474,15 +506,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -494,15 +531,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -521,15 +563,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -541,15 +588,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -561,29 +613,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -614,15 +676,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -647,15 +714,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -668,15 +740,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -689,15 +766,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -722,15 +804,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -755,15 +842,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -782,15 +874,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -815,15 +912,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -856,8 +958,10 @@ "events" : [ { "name" : "mouseout", + "type" : "function", "desc" : "Fires when the mouse exits this menu", - "memberOf" : "Roo.bootstrap.Menu", + "sig" : "function (_self, e, menuItem)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -886,8 +990,10 @@ }, { "name" : "click", + "type" : "function", "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)", - "memberOf" : "Roo.bootstrap.Menu", + "sig" : "function (_self, menuItem, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -916,8 +1022,10 @@ }, { "name" : "mouseover", + "type" : "function", "desc" : "Fires when the mouse is hovering over this menu", - "memberOf" : "Roo.bootstrap.Menu", + "sig" : "function (_self, e, menuItem)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -946,8 +1054,10 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after this menu is hidden", - "memberOf" : "Roo.bootstrap.Menu", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -964,8 +1074,10 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after this menu is displayed", - "memberOf" : "Roo.bootstrap.Menu", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -982,8 +1094,10 @@ }, { "name" : "beforehide", + "type" : "function", "desc" : "Fires before this menu is hidden (return false to block)", - "memberOf" : "Roo.bootstrap.Menu", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1000,8 +1114,10 @@ }, { "name" : "itemclick", + "type" : "function", "desc" : "Fires when a menu item contained in this menu is clicked", - "memberOf" : "Roo.bootstrap.Menu", + "sig" : "function (baseItem, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1024,8 +1140,10 @@ }, { "name" : "beforeshow", + "type" : "function", "desc" : "Fires before this menu is displayed (return false to block)", - "memberOf" : "Roo.bootstrap.Menu", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1042,7 +1160,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1060,7 +1180,9 @@ }, { "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" : "", @@ -1078,7 +1200,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1096,7 +1220,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1114,7 +1240,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1132,7 +1260,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1150,7 +1280,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.MenuItem.json b/docs/symbols/Roo.bootstrap.MenuItem.json index 48badee770..31b6df4063 100644 --- a/docs/symbols/Roo.bootstrap.MenuItem.json +++ b/docs/symbols/Roo.bootstrap.MenuItem.json @@ -23,173 +23,153 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "isContainer", "type" : "Boolean", "desc" : "is it a container - just returns a drop down item..", - "memberOf" : "Roo.bootstrap.MenuItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "menu", "type" : "Roo.bootsrap.Menu", "desc" : "the child menu.", - "memberOf" : "Roo.bootstrap.MenuItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "preventDefault", "type" : "Boolean", "desc" : "do not trigger A href on clicks (default false).", - "memberOf" : "Roo.bootstrap.MenuItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "html", "type" : "String", "desc" : "the menu label", - "memberOf" : "Roo.bootstrap.MenuItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "active", "type" : "Boolean", "desc" : "used on sidebars to highlight active itesm", - "memberOf" : "Roo.bootstrap.MenuItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "fa", "type" : "String", "desc" : "favicon to show on left of menu item.", - "memberOf" : "Roo.bootstrap.MenuItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "href", "type" : "String", "desc" : "the link", - "memberOf" : "Roo.bootstrap.MenuItem", - "optvals" : [] + "memberOf" : "" } ], "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -201,85 +181,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -291,15 +301,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -311,15 +326,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -332,43 +352,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -381,15 +416,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -408,15 +448,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -428,15 +473,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -455,15 +505,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -475,15 +530,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -495,29 +555,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -548,15 +618,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -581,15 +656,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -602,15 +682,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -623,15 +708,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -656,15 +746,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -689,15 +784,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -716,15 +816,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -749,15 +854,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -790,8 +900,10 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "The raw click event for the entire grid.", - "memberOf" : "Roo.bootstrap.MenuItem", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -814,7 +926,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -832,7 +946,9 @@ }, { "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" : "", @@ -850,7 +966,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -868,7 +986,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -886,7 +1006,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -904,7 +1026,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -922,7 +1046,9 @@ }, { "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" : "", @@ -940,7 +1066,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -958,7 +1086,9 @@ }, { "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" : "", @@ -976,7 +1106,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -994,7 +1126,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.MenuMgr.json b/docs/symbols/Roo.bootstrap.MenuMgr.json index b7a3944bbe..d42579645e 100644 --- a/docs/symbols/Roo.bootstrap.MenuMgr.json +++ b/docs/symbols/Roo.bootstrap.MenuMgr.json @@ -12,33 +12,45 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "hideAll", + "type" : "function", "desc" : "Hides all menus that are currently visible", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.MenuMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "get", + "type" : "function", "desc" : "Returns a {@link Roo.menu.Menu} object", + "sig" : "(menu)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.MenuMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "menu", diff --git a/docs/symbols/Roo.bootstrap.MenuSeparator.json b/docs/symbols/Roo.bootstrap.MenuSeparator.json index 77cc509afa..603a5c2ce8 100644 --- a/docs/symbols/Roo.bootstrap.MenuSeparator.json +++ b/docs/symbols/Roo.bootstrap.MenuSeparator.json @@ -23,124 +23,111 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -152,85 +139,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -242,15 +259,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -262,15 +284,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -283,43 +310,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -332,15 +374,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -359,15 +406,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -379,15 +431,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -406,15 +463,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -426,15 +488,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -446,29 +513,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -499,15 +576,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -532,15 +614,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -553,15 +640,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -574,15 +666,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -607,15 +704,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -640,15 +742,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -667,15 +774,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -700,15 +812,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -741,7 +858,9 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -759,7 +878,9 @@ }, { "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" : "", @@ -777,7 +898,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -795,7 +918,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -813,7 +938,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -831,7 +958,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -849,7 +978,9 @@ }, { "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" : "", @@ -867,7 +998,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -885,7 +1018,9 @@ }, { "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" : "", @@ -903,7 +1038,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -921,7 +1058,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.MessageBar.json b/docs/symbols/Roo.bootstrap.MessageBar.json index d6c1e3495c..076f967d64 100644 --- a/docs/symbols/Roo.bootstrap.MessageBar.json +++ b/docs/symbols/Roo.bootstrap.MessageBar.json @@ -23,170 +23,141 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "beforeClass", "type" : "String", "desc" : "insert the bar before the given class", - "memberOf" : "Roo.bootstrap.MessageBar", - "optvals" : [] + "memberOf" : "" }, { "name" : "fixed", "type" : "Boolean", "desc" : "e) default false, fix the bar at the top", - "memberOf" : "Roo.bootstrap.MessageBar", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "html", "type" : "String", "desc" : "contents of the MessageBar", - "memberOf" : "Roo.bootstrap.MessageBar", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "closable", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.MessageBar", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "weight", "type" : "String", "desc" : "r) default info", - "memberOf" : "Roo.bootstrap.MessageBar", - "optvals" : [ - "info", - "success", - "warning", - "danger" - ] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -198,85 +169,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -288,15 +289,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -308,15 +314,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -329,43 +340,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -378,15 +404,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -405,15 +436,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -425,15 +461,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -452,15 +493,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -472,15 +518,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -492,29 +543,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -545,15 +606,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -578,15 +644,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -599,15 +670,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -620,15 +696,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -653,15 +734,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -686,15 +772,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -713,15 +804,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -746,15 +842,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -787,7 +888,9 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -805,7 +908,9 @@ }, { "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" : "", @@ -823,7 +928,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -841,7 +948,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -859,7 +968,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -877,7 +988,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -895,7 +1008,9 @@ }, { "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" : "", @@ -913,7 +1028,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -931,7 +1048,9 @@ }, { "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" : "", @@ -949,7 +1068,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -967,7 +1088,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.MessageBox.json b/docs/symbols/Roo.bootstrap.MessageBox.json index 2e1163ef8e..cd51fd846c 100644 --- a/docs/symbols/Roo.bootstrap.MessageBox.json +++ b/docs/symbols/Roo.bootstrap.MessageBox.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "alert", + "type" : "function", "desc" : "Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert).\nIf a callback function is passed it will be called after the user clicks the button, and the\nid of the button that was clicked will be passed as the only parameter to the callback\n(could also be the top-right close button).", + "sig" : "(title, msg, fn, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.MessageBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "title", @@ -61,15 +68,20 @@ }, { "name" : "confirm", + "type" : "function", "desc" : "Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm).\nIf a callback function is passed it will be called after the user clicks either button, and the id of the\nbutton that was clicked will be passed as the only parameter to the callback (could also be the top-right close button).", + "sig" : "(title, msg, fn, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.MessageBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "title", @@ -106,15 +118,20 @@ }, { "name" : "getDialog", + "type" : "function", "desc" : "Returns a reference to the underlying {@link Roo.BasicDialog} element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.MessageBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -126,15 +143,20 @@ }, { "name" : "progress", + "type" : "function", "desc" : "Displays a message box with a progress bar. This message box has no buttons and is not closeable by\nthe user. You are responsible for updating the progress bar as needed via {@link Roo.MessageBox#updateProgress}\nand closing the message box when the process is complete.", + "sig" : "(title, msg)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.MessageBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "title", @@ -159,29 +181,39 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hides the message box if it is displayed", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.MessageBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "show", + "type" : "function", "desc" : "Displays a new message box, or reinitializes an existing message box, based on the config options\npassed in. All functions (e.g. prompt, alert, etc) on MessageBox call this function internally.\nThe following config object properties are supported:\n
\nProperty    Type             Description\n----------  ---------------  ------------------------------------------------------------------------------------\nanimEl            String/Element   An id or Element from which the message box should animate as it opens and\n                                   closes (defaults to undefined)\nbuttons           Object/Boolean   A button config object (e.g., Roo.MessageBox.OKCANCEL or {ok:'Foo',\n                                   cancel:'Bar'}), or false to not show any buttons (defaults to false)\nclosable          Boolean          False to hide the top-right close button (defaults to true).  Note that\n                                   progress and wait dialogs will ignore this property and always hide the\n                                   close button as they can only be closed programmatically.\ncls               String           A custom CSS class to apply to the message box element\ndefaultTextHeight Number           The default height in pixels of the message box's multiline textarea if\n                                   displayed (defaults to 75)\nfn                Function         A callback function to execute after closing the dialog.  The arguments to the\n                                   function will be btn (the name of the button that was clicked, if applicable,\n                                   e.g. \"ok\"), and text (the value of the active text field, if applicable).\n                                   Progress and wait dialogs will ignore this option since they do not respond to\n                                   user actions and can only be closed programmatically, so any required function\n                                   should be called by the same code after it closes the dialog.\nicon              String           A CSS class that provides a background image to be used as an icon for\n                                   the dialog (e.g., Roo.MessageBox.WARNING or 'custom-class', defaults to '')\nmaxWidth          Number           The maximum width in pixels of the message box (defaults to 600)\nminWidth          Number           The minimum width in pixels of the message box (defaults to 100)\nmodal             Boolean          False to allow user interaction with the page while the message box is\n                                   displayed (defaults to true)\nmsg               String           A string that will replace the existing message box body text (defaults\n                                   to the XHTML-compliant non-breaking space character ' ')\nmultiline         Boolean          True to prompt the user to enter multi-line text (defaults to false)\nprogress          Boolean          True to display a progress bar (defaults to false)\nprogressText      String           The text to display inside the progress bar if progress = true (defaults to '')\nprompt            Boolean          True to prompt the user to enter single-line text (defaults to false)\nproxyDrag         Boolean          True to display a lightweight proxy while dragging (defaults to false)\ntitle             String           The title text\nvalue             String           The string value to set into the active textbox element if displayed\nwait              Boolean          True to display a progress bar (defaults to false)\nwidth             Number           The width of the dialog in pixels\n
\n\nExample usage:\n
\nRoo.Msg.show({\n   title: 'Address',\n   msg: 'Please enter your address:',\n   width: 300,\n   buttons: Roo.MessageBox.OKCANCEL,\n   multiline: true,\n   fn: saveAddress,\n   animEl: 'addAddressBtn'\n});\n
", + "sig" : "(config)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.MessageBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -200,15 +232,20 @@ }, { "name" : "isVisible", + "type" : "function", "desc" : "Returns true if the message box is currently displayed", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.MessageBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -220,15 +257,20 @@ }, { "name" : "wait", + "type" : "function", "desc" : "Displays a message box with an infinitely auto-updating progress bar. This can be used to block user\ninteraction while waiting for a long-running process to complete that does not have defined intervals.\nYou are responsible for closing the message box when the process is complete.", + "sig" : "(msg, title)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.MessageBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -253,15 +295,20 @@ }, { "name" : "updateText", + "type" : "function", "desc" : "Updates the message box body text", + "sig" : "(text)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.MessageBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "text", @@ -280,15 +327,20 @@ }, { "name" : "updateProgress", + "type" : "function", "desc" : "Updates a progress-style message box's text and progress bar. Only relevant on message boxes\ninitiated via {@link Roo.MessageBox#progress} or by calling {@link Roo.MessageBox#show} with progress: true.", + "sig" : "(value, text)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.MessageBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -313,15 +365,20 @@ }, { "name" : "prompt", + "type" : "function", "desc" : "Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to\nJavaScript's Window.prompt). The prompt can be a single-line or multi-line textbox. If a callback function\nis passed it will be called after the user clicks either button, and the id of the button that was clicked\n(could also be the top-right close button) and the text that was entered will be passed as the two\nparameters to the callback.", + "sig" : "(title, msg, fn, scope, multiline)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.MessageBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "title", diff --git a/docs/symbols/Roo.bootstrap.Modal.json b/docs/symbols/Roo.bootstrap.Modal.json index 2af3b9ba0e..f09faa7906 100644 --- a/docs/symbols/Roo.bootstrap.Modal.json +++ b/docs/symbols/Roo.bootstrap.Modal.json @@ -23,237 +23,201 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "editableTitle", "type" : "Boolean", "desc" : "can the title be edited", - "memberOf" : "Roo.bootstrap.Modal", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "bodyOverflow", "type" : "Boolean", "desc" : "should the body element have overflow auto added default false", - "memberOf" : "Roo.bootstrap.Modal", - "optvals" : [] + "memberOf" : "" }, { "name" : "max_width", "type" : "Number", "desc" : "set the max width of modal", - "memberOf" : "Roo.bootstrap.Modal", - "optvals" : [] + "memberOf" : "" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "buttons", "type" : "Array", "desc" : "Array of buttons or standard button set..", - "memberOf" : "Roo.bootstrap.Modal", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "title", "type" : "String", "desc" : "Title of dialog", - "memberOf" : "Roo.bootstrap.Modal", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "tmpl", "type" : "Roo.Template", "desc" : "- a template with variables. to use it, add a handler in show:method adn", - "memberOf" : "Roo.bootstrap.Modal", - "optvals" : [] + "memberOf" : "" }, { "name" : "html", "type" : "String", "desc" : "- the body of the dialog (for simple ones) - you can also use template..", - "memberOf" : "Roo.bootstrap.Modal", - "optvals" : [] + "memberOf" : "" }, { "name" : "buttonPosition", "type" : "String", "desc" : "r) default right (DEPRICATED) - use mr-auto on buttons to put them on the left", - "memberOf" : "Roo.bootstrap.Modal", - "optvals" : [ - "left", - "right", - "center" - ] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "fitwindow", "type" : "Boolean", "desc" : "default false", - "memberOf" : "Roo.bootstrap.Modal", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "specificTitle", "type" : "Boolean", "desc" : "default false", - "memberOf" : "Roo.bootstrap.Modal", - "optvals" : [] + "memberOf" : "" }, { "name" : "width", "type" : "Number", "desc" : "fixed width - usefull for chrome extension only really.", - "memberOf" : "Roo.bootstrap.Modal", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "allow_close", "type" : "Boolean", "desc" : "default true", - "memberOf" : "Roo.bootstrap.Modal", - "optvals" : [] + "memberOf" : "" }, { "name" : "height", "type" : "Number", "desc" : "fixed height - usefull for chrome extension only really.", - "memberOf" : "Roo.bootstrap.Modal", - "optvals" : [] + "memberOf" : "" }, { "name" : "size", "type" : "String", "desc" : "l) default empty", - "memberOf" : "Roo.bootstrap.Modal", - "optvals" : [ - "sm", - "lg", - "xl" - ] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "animate", "type" : "Boolean", "desc" : "default true", - "memberOf" : "Roo.bootstrap.Modal", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "applyBody", + "type" : "function", "desc" : "Set the body of the Dialog using the template", + "sig" : "(data)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Modal", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "data", @@ -266,15 +230,20 @@ }, { "name" : "setTitle", + "type" : "function", "desc" : "Set the title of the Dialog", + "sig" : "(str)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Modal", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "str", @@ -287,15 +256,20 @@ }, { "name" : "setBody", + "type" : "function", "desc" : "Set the body of the Dialog", + "sig" : "(str)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Modal", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "str", @@ -308,15 +282,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -328,85 +307,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -418,15 +427,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -438,15 +452,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -459,43 +478,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -508,15 +542,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -535,15 +574,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -555,15 +599,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -582,15 +631,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -602,15 +656,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -622,29 +681,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -675,15 +744,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -708,15 +782,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -729,15 +808,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -750,15 +834,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -783,15 +872,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -816,15 +910,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -843,15 +942,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -876,15 +980,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -917,8 +1026,10 @@ "events" : [ { "name" : "titlechanged", + "type" : "function", "desc" : "Fire when the editable title has been changed", - "memberOf" : "Roo.bootstrap.Modal", + "sig" : "function (_self, value)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -941,8 +1052,10 @@ }, { "name" : "btnclick", + "type" : "function", "desc" : "The raw btnclick event for the button", - "memberOf" : "Roo.bootstrap.Modal", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -959,8 +1072,10 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fire when dialog resize", - "memberOf" : "Roo.bootstrap.Modal", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -983,7 +1098,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1001,7 +1118,9 @@ }, { "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" : "", @@ -1019,7 +1138,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1037,7 +1158,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1055,7 +1178,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1073,7 +1198,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1091,7 +1218,9 @@ }, { "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" : "", @@ -1109,7 +1238,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1127,7 +1258,9 @@ }, { "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" : "", @@ -1145,7 +1278,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1163,7 +1298,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.MoneyField.json b/docs/symbols/Roo.bootstrap.MoneyField.json index 2ed1463e87..3669ae72a0 100644 --- a/docs/symbols/Roo.bootstrap.MoneyField.json +++ b/docs/symbols/Roo.bootstrap.MoneyField.json @@ -26,1017 +26,831 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "growMax", "type" : "Number", "desc" : "", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "md", "type" : "Number", "desc" : "colspan out of 12 for computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "grow", "type" : "Boolean", "desc" : "", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "queryDelay", "type" : "Number", "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "triggerAction", "type" : "String", "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "resizable", "type" : "Boolean", "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "mobileTouchView", "type" : "Boolean", "desc" : "e) show mobile touch view when using a mobile default true", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "labelmd", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "editable", "type" : "Boolean", "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "defaults", "type" : "String", "desc" : "currency of the MoneyField\nvalue should be in lkey", - "memberOf" : "Roo.bootstrap.MoneyField", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "thousandsDelimiter", "type" : "String", "desc" : "Symbol of thousandsDelimiter", - "memberOf" : "Roo.bootstrap.MoneyField", - "optvals" : [] + "memberOf" : "" }, { "name" : "castInt", "type" : "Boolean", "desc" : "e) cast int if true (defalut true)", - "memberOf" : "Roo.bootstrap.MoneyField", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "listWidth", "type" : "Number", "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "alwaysQuery", "type" : "Boolean", "desc" : "Disable caching of results, and always send query", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "handleHeight", "type" : "Number", "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "emptyResultText", "type" : "Boolean", "desc" : "only for touch device", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "title", "type" : "String", "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "allowZero", "type" : "Boolean", "desc" : "False to blank out if the user enters '0' (defaults to true)", - "memberOf" : "Roo.bootstrap.MoneyField", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "max_length", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.bootstrap.MoneyField", - "optvals" : [] + "memberOf" : "" }, { "name" : "minValue", "type" : "Number", "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)", - "memberOf" : "Roo.bootstrap.MoneyField", - "optvals" : [] + "memberOf" : "" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "after", "type" : "string", "desc" : "- input group add on after", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "name", "type" : "String", "desc" : "name of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "queryParam", "type" : "String", "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "tpl", "type" : "String/Roo.Template", "desc" : "The template to use to render the output default is '
{' + this.displayField + '}'", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "selectedClass", "type" : "String", "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "autocomplete", "type" : "String", "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)", "type" : "String", "desc" : "inputType", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hiddenName", "type" : "String", "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "sm", "type" : "Number", "desc" : "colspan out of 12 for tablet-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "autoCreate", "type" : "Boolean/Object", "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "allowNegative", "type" : "Boolean", "desc" : "False to prevent entering a negative sign (defaults to true)", - "memberOf" : "Roo.bootstrap.MoneyField", - "optvals" : [] + "memberOf" : "" }, { "name" : "removable", "type" : "Boolean", "desc" : "e) special filter default false", - "memberOf" : "Roo.bootstrap.TriggerField", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.TriggerField" }, { "name" : "minChars", "type" : "Number", "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "animate", "type" : "Boolean", "desc" : "default true", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "btnPosition", "type" : "String", "desc" : "set the position of the trigger button (left | right) default right", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "disableClear", "type" : "Boolean", "desc" : "Disable showing of clear button.", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "xs", "type" : "Number", "desc" : "colspan out of 12 for mobile-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "lazyRender", "type" : "Boolean", "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "labelsm", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelxs", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "listAlign", "type" : "String", "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "showToggleBtn", "type" : "Boolean", "desc" : "show toggle button or not (true|false) default true", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "invalidFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "triggerList", "type" : "Boolean", "desc" : "trigger show the list or not (true|false) default true", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "mode", "type" : "String", "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "typeAhead", "type" : "Boolean", "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "triggerText", "type" : "String", "desc" : "multiple combobox trigger button text default 'Select'", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "regexText", "type" : "String", "desc" : "-- Depricated - use Invalid Text", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "fieldLabel", "type" : "string", "desc" : "- the label associated", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "growMin", "type" : "Number", "desc" : "", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "minText", "type" : "String", "desc" : "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")", - "memberOf" : "Roo.bootstrap.MoneyField", - "optvals" : [] + "memberOf" : "" }, { "name" : "disabled", "type" : "Boolean", "desc" : "is it disabled", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "triggerClass", "type" : "String", "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be appended if specified.", - "memberOf" : "Roo.bootstrap.TriggerField", - "optvals" : [] + "memberOf" : "Roo.bootstrap.TriggerField" }, { "name" : "validClass", "type" : "String", "desc" : "DEPRICATED - uses BS4 is-valid now", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "modalTitle", "type" : "String", "desc" : "The title of the dialog that pops up on mobile views.", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "preventMark", "type" : "Boolean", "desc" : "Do not show tick or cross if error/success", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "valueField", "type" : "String", "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "store", "type" : "Roo.data.Store", "desc" : "The data store to which this combo is bound (defaults to undefined)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "invalidClass", "type" : "String", "desc" : "DEPRICATED - uses BS4 is-valid now", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "listClass", "type" : "String", "desc" : "CSS class to apply to the dropdown list element (defaults to '')", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "displayField", "type" : "String", "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "tickable", "type" : "Boolean", "desc" : "ComboBox with tickable selections (true|false), default false", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "specialFilter", "type" : "Boolean", "desc" : "e) special filter default false", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "emptyTitle", "type" : "String", "desc" : "default ''", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "typeAheadDelay", "type" : "Number", "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "loadingText", "type" : "String", "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "size", "type" : "string", "desc" : "- (lg|sm) or leave empty..", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "width", "type" : "Number", "desc" : "fixed with? experimental", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "caret", "type" : "String", "desc" : "r) BS3 only - carat fa name", - "memberOf" : "Roo.bootstrap.TriggerField", - "optvals" : [ - "search", - "calendar" - ] + "memberOf" : "Roo.bootstrap.TriggerField" }, { "name" : "hideTrigger", "type" : "Boolean", "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", - "memberOf" : "Roo.bootstrap.TriggerField", - "optvals" : [] + "memberOf" : "Roo.bootstrap.TriggerField" }, { "name" : "minListWidth", "type" : "Number", "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "multiple", "type" : "Boolean", "desc" : "e) ComboBobArray, default false", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "placeholder", "type" : "string", "desc" : "- placeholder to put in text.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "before", "type" : "string", "desc" : "- input group add on before", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "Specifies that the field should be read-only", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxHeight", "type" : "Number", "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "maxValue", "type" : "Number", "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.bootstrap.MoneyField", - "optvals" : [] + "memberOf" : "" }, { "name" : "mobile_restrict_height", "type" : "Boolean", "desc" : "e) restrict height for touch view", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "allowDecimals", "type" : "Boolean", "desc" : "False to disallow decimal values (defaults to true)", - "memberOf" : "Roo.bootstrap.MoneyField", - "optvals" : [] + "memberOf" : "" }, { "name" : "nanText", "type" : "String", "desc" : "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")", - "memberOf" : "Roo.bootstrap.MoneyField", - "optvals" : [] + "memberOf" : "" }, { "name" : "valueNotFoundText", "type" : "String", "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "validFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "decimalSeparator", "type" : "String", "desc" : "Character(s) to allow as the decimal separator (defaults to '.')", - "memberOf" : "Roo.bootstrap.MoneyField", - "optvals" : [] + "memberOf" : "" }, { "name" : "autoFocus", "type" : "Boolean", "desc" : "e) auto focus the first item, default true", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "lg", "type" : "Number", "desc" : "colspan out of 12 for large computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "pageSize", "type" : "Number", "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "useNativeIOS", "type" : "Boolean", "desc" : "e) render it as classic select for ios, not support dynamic load data (default false)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "forceSelection", "type" : "Boolean", "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "labelWidth", "type" : "Number", "desc" : "set the width of label", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "append", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labellg", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allQuery", "type" : "String", "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "blockFocus", "type" : "Boolean", "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "shadow", "type" : "Boolean/String", "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right", - "memberOf" : "Roo.bootstrap.ComboBox", - "optvals" : [] + "memberOf" : "Roo.bootstrap.ComboBox" }, { "name" : "maxText", "type" : "String", "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")", - "memberOf" : "Roo.bootstrap.MoneyField", - "optvals" : [] + "memberOf" : "" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "value", "type" : "string", "desc" : "default value of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "decimalPrecision", "type" : "Number", "desc" : "The maximum precision to display after the decimal separator (defaults to 2)", - "memberOf" : "Roo.bootstrap.MoneyField", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "select", + "type" : "function", "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "sig" : "(index, scrollIntoView)", + "static" : false, + "memberOf" : "Roo.bootstrap.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -1055,43 +869,58 @@ }, { "name" : "expand", + "type" : "function", "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "collapse", + "type" : "function", "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the currently selected field value or empty string if no value is set.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1103,15 +932,20 @@ }, { "name" : "selectByValue", + "type" : "function", "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "sig" : "(value, scrollIntoView)", + "static" : false, + "memberOf" : "Roo.bootstrap.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -1136,15 +970,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -1157,15 +996,20 @@ }, { "name" : "setFromData", + "type" : "function", "desc" : "Sets the value of the field based on a object which is related to the record format for the store.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -1178,15 +1022,20 @@ }, { "name" : "setEditable", + "type" : "function", "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -1199,43 +1048,58 @@ }, { "name" : "clearValue", + "type" : "function", "desc" : "Clears any text/value currently set in the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isExpanded", + "type" : "function", "desc" : "Returns true if the dropdown list is expanded, else false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "doQuery", + "type" : "function", "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.", + "sig" : "(query, forceAll)", + "static" : false, + "memberOf" : "Roo.bootstrap.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "query", @@ -1254,15 +1118,20 @@ }, { "name" : "onTriggerClick", + "type" : "function", "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.bootstrap.TriggerField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TriggerField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -1275,43 +1144,58 @@ }, { "name" : "autoSize", + "type" : "function", "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.TriggerField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TriggerField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1323,15 +1207,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -1344,15 +1233,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1364,29 +1258,39 @@ }, { "name" : "markValid", + "type" : "function", "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1398,29 +1302,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -1433,29 +1347,39 @@ }, { "name" : "inputEl", + "type" : "function", "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -1474,15 +1398,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1494,85 +1423,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1584,15 +1543,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1604,15 +1568,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -1625,43 +1594,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -1674,15 +1658,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -1701,15 +1690,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1721,15 +1715,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1748,15 +1747,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1768,15 +1772,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1788,29 +1797,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1841,15 +1860,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1874,15 +1898,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1895,15 +1924,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1916,15 +1950,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1949,15 +1988,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1982,15 +2026,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -2009,15 +2058,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -2042,15 +2096,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -2083,7 +2142,9 @@ "events" : [ { "name" : "edit", + "type" : "function", "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)", + "sig" : "function (combo, record)\n{\n\n}", "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", @@ -2107,7 +2168,9 @@ }, { "name" : "afterremove", + "type" : "function", "desc" : "Fires when the remove value from the combobox array", + "sig" : "function (combo)\n{\n\n}", "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", @@ -2125,7 +2188,9 @@ }, { "name" : "touchviewdisplay", + "type" : "function", "desc" : "Fires when touch view require special display (default is using displayField)", + "sig" : "function (combo, cfg)\n{\n\n}", "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", @@ -2149,7 +2214,9 @@ }, { "name" : "beforequery", + "type" : "function", "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:", + "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", @@ -2191,7 +2258,9 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Fires when the remove value from the combobox array", + "sig" : "function (combo)\n{\n\n}", "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", @@ -2209,7 +2278,9 @@ }, { "name" : "beforeselect", + "type" : "function", "desc" : "Fires before a list item is selected. Return false to cancel the selection.", + "sig" : "function (combo, record, index)\n{\n\n}", "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", @@ -2239,7 +2310,9 @@ }, { "name" : "tick", + "type" : "function", "desc" : "Fires when tick the element", + "sig" : "function (combo)\n{\n\n}", "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", @@ -2257,7 +2330,9 @@ }, { "name" : "add", + "type" : "function", "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)", + "sig" : "function (combo)\n{\n\n}", "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", @@ -2275,7 +2350,9 @@ }, { "name" : "expand", + "type" : "function", "desc" : "Fires when the dropdown list is expanded", + "sig" : "function (combo)\n{\n\n}", "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", @@ -2293,7 +2370,9 @@ }, { "name" : "specialfilter", + "type" : "function", "desc" : "Fires when specialfilter", + "sig" : "function (combo)\n{\n\n}", "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", @@ -2311,7 +2390,9 @@ }, { "name" : "collapse", + "type" : "function", "desc" : "Fires when the dropdown list is collapsed", + "sig" : "function (combo)\n{\n\n}", "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", @@ -2329,7 +2410,9 @@ }, { "name" : "select", + "type" : "function", "desc" : "Fires when a list item is selected", + "sig" : "function (combo, record, index)\n{\n\n}", "memberOf" : "Roo.bootstrap.ComboBox", "example" : "", "deprecated" : "", @@ -2359,7 +2442,9 @@ }, { "name" : "paste", + "type" : "function", "desc" : "Fires after the user pastes into input", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -2383,7 +2468,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -2413,7 +2500,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -2437,7 +2526,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -2455,7 +2546,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -2473,7 +2566,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -2497,7 +2592,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -2515,7 +2612,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -2539,7 +2638,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -2557,7 +2658,9 @@ }, { "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" : "", @@ -2575,7 +2678,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2593,7 +2698,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2611,7 +2718,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2629,7 +2738,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2647,7 +2758,9 @@ }, { "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" : "", @@ -2665,7 +2778,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2683,7 +2798,9 @@ }, { "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" : "", @@ -2701,7 +2818,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2719,7 +2838,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.MonthField.json b/docs/symbols/Roo.bootstrap.MonthField.json index 378662888e..8b2dac0646 100644 --- a/docs/symbols/Roo.bootstrap.MonthField.json +++ b/docs/symbols/Roo.bootstrap.MonthField.json @@ -24,511 +24,430 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "validFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "lg", "type" : "Number", "desc" : "colspan out of 12 for large computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)", "type" : "String", "desc" : "inputType", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xs", "type" : "Number", "desc" : "colspan out of 12 for mobile-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "disabled", "type" : "Boolean", "desc" : "is it disabled", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "String", "desc" : "name of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "autocomplete", "type" : "String", "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "regexText", "type" : "String", "desc" : "-- Depricated - use Invalid Text", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "labelmd", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "value", "type" : "string", "desc" : "default value of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "sm", "type" : "Number", "desc" : "colspan out of 12 for tablet-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "Specifies that the field should be read-only", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "language", "type" : "String", "desc" : "default en", - "memberOf" : "Roo.bootstrap.MonthField", - "optvals" : [] + "memberOf" : "" }, { "name" : "size", "type" : "string", "desc" : "- (lg|sm) or leave empty..", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labellg", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelxs", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "fieldLabel", "type" : "string", "desc" : "- the label associated", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "before", "type" : "string", "desc" : "- input group add on before", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "invalidFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "placeholder", "type" : "string", "desc" : "- placeholder to put in text.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "md", "type" : "Number", "desc" : "colspan out of 12 for computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", "type" : "Number", "desc" : "set the width of label", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "preventMark", "type" : "Boolean", "desc" : "Do not show tick or cross if error/success", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelsm", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "after", "type" : "string", "desc" : "- input group add on after", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" } ], "methods" : [ { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -540,15 +459,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -561,15 +485,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -581,29 +510,39 @@ }, { "name" : "markValid", + "type" : "function", "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -615,29 +554,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -649,15 +598,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -670,15 +624,20 @@ }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -691,29 +650,39 @@ }, { "name" : "inputEl", + "type" : "function", "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -732,15 +701,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -752,85 +726,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -842,15 +846,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -862,15 +871,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -883,43 +897,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -932,15 +961,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -959,15 +993,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -979,15 +1018,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1006,15 +1050,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1026,15 +1075,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1046,29 +1100,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1099,15 +1163,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1132,15 +1201,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1153,15 +1227,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1174,15 +1253,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1207,15 +1291,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1240,15 +1329,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1267,15 +1361,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1300,15 +1399,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1341,8 +1445,10 @@ "events" : [ { "name" : "show", + "type" : "function", "desc" : "Fires when this field show.", - "memberOf" : "Roo.bootstrap.MonthField", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1365,8 +1471,10 @@ }, { "name" : "select", + "type" : "function", "desc" : "Fires when select a date.", - "memberOf" : "Roo.bootstrap.MonthField", + "sig" : "function (_self, oldvalue, newvalue)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1395,7 +1503,9 @@ }, { "name" : "paste", + "type" : "function", "desc" : "Fires after the user pastes into input", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1419,7 +1529,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1449,7 +1561,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1473,7 +1587,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1491,7 +1607,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1509,7 +1627,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1533,7 +1653,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1551,7 +1673,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1575,7 +1699,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1593,7 +1719,9 @@ }, { "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" : "", @@ -1611,7 +1739,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1629,7 +1759,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1647,7 +1779,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1665,7 +1799,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1683,7 +1819,9 @@ }, { "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" : "", @@ -1701,7 +1839,9 @@ }, { "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" : "", @@ -1719,7 +1859,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1737,7 +1879,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.NavGroup.json b/docs/symbols/Roo.bootstrap.NavGroup.json index 4c9bd216c5..d6f2f60c58 100644 --- a/docs/symbols/Roo.bootstrap.NavGroup.json +++ b/docs/symbols/Roo.bootstrap.NavGroup.json @@ -23,166 +23,141 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "align", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.NavGroup", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "" }, { "name" : "inverse", "type" : "Boolean", "desc" : "", - "memberOf" : "Roo.bootstrap.NavGroup", - "optvals" : [] + "memberOf" : "" }, { "name" : "pilltype", "type" : "Boolean", "desc" : "default true (turn to off to disable active toggle)", - "memberOf" : "Roo.bootstrap.NavGroup", - "optvals" : [] + "memberOf" : "" }, { "name" : "navId", "type" : "String", "desc" : "- reference Id for navbar.", - "memberOf" : "Roo.bootstrap.NavGroup", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "type", "type" : "String", "desc" : "b) default nav", - "memberOf" : "Roo.bootstrap.NavGroup", - "optvals" : [ - "nav", - "pills", - "tab" - ] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "register", + "type" : "function", "desc" : "register a Navigation item", + "sig" : "(the)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.NavGroup", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -195,15 +170,20 @@ }, { "name" : "getActive", + "type" : "function", "desc" : "gets the active Navigation item", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.NavGroup", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -215,15 +195,20 @@ }, { "name" : "addItem", + "type" : "function", "desc" : "adds a Navigation item", + "sig" : "(the)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.NavGroup", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -236,15 +221,20 @@ }, { "name" : "register", + "type" : "function", "desc" : "register a Navigation Group", + "sig" : "(the)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.NavGroup", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -257,15 +247,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.NavGroup", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -278,15 +273,20 @@ }, { "name" : "setActiveItem", + "type" : "function", "desc" : "sets the active Navigation item", + "sig" : "(the)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.NavGroup", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -299,29 +299,39 @@ }, { "name" : "clearAll", + "type" : "function", "desc" : "clear all the Navigation item", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.NavGroup", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -333,85 +343,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -423,15 +463,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -443,15 +488,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -464,43 +514,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -513,15 +578,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -540,15 +610,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -560,15 +635,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -587,15 +667,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -607,15 +692,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -627,29 +717,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -680,15 +780,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -713,15 +818,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -734,15 +844,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -755,15 +870,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -788,15 +908,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -821,15 +946,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -848,15 +978,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -881,15 +1016,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -922,8 +1062,10 @@ "events" : [ { "name" : "changed", + "type" : "function", "desc" : "Fires when the active item changes", - "memberOf" : "Roo.bootstrap.NavGroup", + "sig" : "function (_self, selected, prev)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -952,7 +1094,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -970,7 +1114,9 @@ }, { "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" : "", @@ -988,7 +1134,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1006,7 +1154,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1024,7 +1174,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1042,7 +1194,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1060,7 +1214,9 @@ }, { "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" : "", @@ -1078,7 +1234,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1096,7 +1254,9 @@ }, { "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" : "", @@ -1114,7 +1274,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1132,7 +1294,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.NavHeaderbar.json b/docs/symbols/Roo.bootstrap.NavHeaderbar.json index 8d3714800a..0cc1f494cd 100644 --- a/docs/symbols/Roo.bootstrap.NavHeaderbar.json +++ b/docs/symbols/Roo.bootstrap.NavHeaderbar.json @@ -25,289 +25,239 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "brand_href", "type" : "String", "desc" : "href of the brand", - "memberOf" : "Roo.bootstrap.NavHeaderbar", - "optvals" : [] + "memberOf" : "" }, { "name" : "desktopCenter", "type" : "Boolean", "desc" : "should the header be centered on desktop using a container class", - "memberOf" : "Roo.bootstrap.NavHeaderbar", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "inverse", "type" : "Boolean", "desc" : "is inverted color", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "align", "type" : "String", "desc" : "t) alignment", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "brand", "type" : "String", "desc" : "what is brand", - "memberOf" : "Roo.bootstrap.NavHeaderbar", - "optvals" : [] + "memberOf" : "" }, { "name" : "position", "type" : "String", "desc" : "p) position", - "memberOf" : "Roo.bootstrap.NavHeaderbar", - "optvals" : [ - "fixed-top", - "fixed-bottom", - "static-top" - ] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "srButton", "type" : "Boolean", "desc" : "generate the (screen reader / mobile) sr-only button default true", - "memberOf" : "Roo.bootstrap.NavHeaderbar", - "optvals" : [] + "memberOf" : "" }, { "name" : "tag", "type" : "String", "desc" : "v) default is nav", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "header", - "footer", - "nav", - "div" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "mobilerow", "type" : "Roo.bootstrap.Row", "desc" : "- a row to display on mobile only..", - "memberOf" : "Roo.bootstrap.NavHeaderbar", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "arrangement", "type" : "Boolean", "desc" : "stacked | justified", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "loadMask", "type" : "Boolean", "desc" : "e) loadMask on the bar", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "main", "type" : "Boolean", "desc" : "e) main nav bar? default false", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "type", "type" : "String", "desc" : "s)", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "nav", - "pills", - "tabs" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "weight", "type" : "String", "desc" : "e) default is light.", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "light", - "primary", - "secondary", - "success", - "danger", - "warning", - "info", - "dark", - "white" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "autohide", "type" : "Boolean", "desc" : "a top nav bar header that hides on scroll.", - "memberOf" : "Roo.bootstrap.NavHeaderbar", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "collapse", + "type" : "function", "desc" : "Collapse the navbar pulldown", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Navbar", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Navbar", "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.Navbar", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Navbar", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -319,85 +269,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -409,15 +389,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -429,15 +414,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -450,43 +440,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -499,15 +504,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -526,15 +536,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -546,15 +561,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -573,15 +593,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -593,15 +618,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -613,29 +643,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -666,15 +706,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -699,15 +744,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -720,15 +770,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -741,15 +796,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -774,15 +834,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -807,15 +872,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -834,15 +904,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -867,15 +942,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -908,7 +988,9 @@ "events" : [ { "name" : "beforetoggle", + "type" : "function", "desc" : "Fire before toggle the menu", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Navbar", "example" : "", "deprecated" : "", @@ -926,7 +1008,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -944,7 +1028,9 @@ }, { "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" : "", @@ -962,7 +1048,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -980,7 +1068,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -998,7 +1088,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1016,7 +1108,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1034,7 +1128,9 @@ }, { "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" : "", @@ -1052,7 +1148,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1070,7 +1168,9 @@ }, { "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" : "", @@ -1088,7 +1188,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1106,7 +1208,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.NavItem.json b/docs/symbols/Roo.bootstrap.NavItem.json index cbc0af6f01..151e52795a 100644 --- a/docs/symbols/Roo.bootstrap.NavItem.json +++ b/docs/symbols/Roo.bootstrap.NavItem.json @@ -23,260 +23,207 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "linkcls", "type" : "String", "desc" : "Link Class", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "tagtype", "type" : "String", "desc" : "n) render as a href or span?", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [ - "a", - "span" - ] + "memberOf" : "" }, { "name" : "animateRef", "type" : "Boolean", "desc" : "e) link to element default false", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "tabId", "type" : "String", "desc" : "the tab that this item activates.", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "badge", "type" : "String", "desc" : "text inside badge", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "disabled", "type" : "Boolean", "desc" : "Is item disabled", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "button_outline", "type" : "Boolean", "desc" : "show and outlined button", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "html", "type" : "String", "desc" : "content of button", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "preventDefault", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "glyphicon", "type" : "String", "desc" : "DEPRICATED - use fa", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "icon", "type" : "String", "desc" : "DEPRICATED - use fa", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "badgecls", "type" : "String", "desc" : "w)the extra classes for the badge", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [ - "bg-green", - "bg-red", - "bg-yellow" - ] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "button_weight", "type" : "String", "desc" : "k) default none", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [ - "default", - "primary", - "secondary", - "success", - "info", - "warning", - "danger", - "link", - "light", - "dark" - ] + "memberOf" : "" }, { "name" : "fa", "type" : "String", "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "active", "type" : "Boolean", "desc" : "Is item active", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "href", "type" : "String", "desc" : "link to", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "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, - "memberOf" : "Roo.bootstrap.NavItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -288,15 +235,20 @@ }, { "name" : "setHtml", + "type" : "function", "desc" : "Set the HTML (text content) of the item", + "sig" : "(html)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.NavItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "html", @@ -309,85 +261,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -399,15 +381,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -419,15 +406,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -440,43 +432,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -489,15 +496,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -516,15 +528,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -536,15 +553,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -563,15 +585,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -583,15 +610,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -603,29 +635,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -656,15 +698,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -689,15 +736,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -710,15 +762,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -731,15 +788,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -764,15 +826,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -797,15 +864,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -824,15 +896,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -857,15 +934,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -898,8 +980,10 @@ "events" : [ { "name" : "changed", + "type" : "function", "desc" : "Fires when the active item active state changes", - "memberOf" : "Roo.bootstrap.NavItem", + "sig" : "function (_self, state)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -922,8 +1006,10 @@ }, { "name" : "scrollto", + "type" : "function", "desc" : "Fires when scroll to element", - "memberOf" : "Roo.bootstrap.NavItem", + "sig" : "function (_self, options, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -952,8 +1038,10 @@ }, { "name" : "click", + "type" : "function", "desc" : "The raw click event for the entire grid.", - "memberOf" : "Roo.bootstrap.NavItem", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -970,7 +1058,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -988,7 +1078,9 @@ }, { "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" : "", @@ -1006,7 +1098,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1024,7 +1118,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1042,7 +1138,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1060,7 +1158,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1078,7 +1178,9 @@ }, { "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" : "", @@ -1096,7 +1198,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1114,7 +1218,9 @@ }, { "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" : "", @@ -1132,7 +1238,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1150,7 +1258,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.NavProgressBar.json b/docs/symbols/Roo.bootstrap.NavProgressBar.json index 0a1b75c6cc..b1695fbbce 100644 --- a/docs/symbols/Roo.bootstrap.NavProgressBar.json +++ b/docs/symbols/Roo.bootstrap.NavProgressBar.json @@ -23,124 +23,111 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -152,85 +139,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -242,15 +259,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -262,15 +284,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -283,43 +310,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -332,15 +374,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -359,15 +406,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -379,15 +431,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -406,15 +463,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -426,15 +488,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -446,29 +513,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -499,15 +576,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -532,15 +614,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -553,15 +640,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -574,15 +666,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -607,15 +704,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -640,15 +742,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -667,15 +774,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -700,15 +812,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -741,8 +858,10 @@ "events" : [ { "name" : "changed", + "type" : "function", "desc" : "Fires when the active item changes", - "memberOf" : "Roo.bootstrap.NavProgressBar", + "sig" : "function (_self, selected, prev)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -771,7 +890,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -789,7 +910,9 @@ }, { "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" : "", @@ -807,7 +930,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -825,7 +950,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -843,7 +970,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -861,7 +990,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -879,7 +1010,9 @@ }, { "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" : "", @@ -897,7 +1030,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -915,7 +1050,9 @@ }, { "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" : "", @@ -933,7 +1070,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -951,7 +1090,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.NavProgressItem.json b/docs/symbols/Roo.bootstrap.NavProgressItem.json index cc7b05cda6..0a80308aea 100644 --- a/docs/symbols/Roo.bootstrap.NavProgressItem.json +++ b/docs/symbols/Roo.bootstrap.NavProgressItem.json @@ -23,175 +23,147 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "rid", "type" : "String", "desc" : "the reference id", - "memberOf" : "Roo.bootstrap.NavProgressItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "position", "type" : "String", "desc" : "m) text position default bottom", - "memberOf" : "Roo.bootstrap.NavProgressItem", - "optvals" : [ - "top", - "bottom" - ] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disabled", "type" : "Boolean", "desc" : "e) Is item active default false", - "memberOf" : "Roo.bootstrap.NavProgressItem", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "html", "type" : "String", "desc" : "", - "memberOf" : "Roo.bootstrap.NavProgressItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "icon", "type" : "String", "desc" : "show icon instead of number", - "memberOf" : "Roo.bootstrap.NavProgressItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "active", "type" : "Boolean", "desc" : "e) Is item active default false", - "memberOf" : "Roo.bootstrap.NavProgressItem", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -203,85 +175,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -293,15 +295,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -313,15 +320,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -334,43 +346,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -383,15 +410,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -410,15 +442,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -430,15 +467,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -457,15 +499,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -477,15 +524,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -497,29 +549,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -550,15 +612,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -583,15 +650,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -604,15 +676,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -625,15 +702,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -658,15 +740,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -691,15 +778,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -718,15 +810,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -751,15 +848,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -792,8 +894,10 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "The raw click event for the entire grid.", - "memberOf" : "Roo.bootstrap.NavProgressItem", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -816,7 +920,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -834,7 +940,9 @@ }, { "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" : "", @@ -852,7 +960,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -870,7 +980,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -888,7 +1000,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -906,7 +1020,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -924,7 +1040,9 @@ }, { "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" : "", @@ -942,7 +1060,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -960,7 +1080,9 @@ }, { "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" : "", @@ -978,7 +1100,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -996,7 +1120,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.NavSidebar.json b/docs/symbols/Roo.bootstrap.NavSidebar.json index 713d1cb901..f23ad2f75e 100644 --- a/docs/symbols/Roo.bootstrap.NavSidebar.json +++ b/docs/symbols/Roo.bootstrap.NavSidebar.json @@ -24,152 +24,149 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "collapse", + "type" : "function", "desc" : "Collapse the navbar pulldown", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Navbar", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Navbar", "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.Navbar", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Navbar", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -181,85 +178,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -271,15 +298,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -291,15 +323,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -312,43 +349,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -361,15 +413,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -388,15 +445,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -408,15 +470,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -435,15 +502,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -455,15 +527,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -475,29 +552,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -528,15 +615,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -561,15 +653,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -582,15 +679,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -603,15 +705,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -636,15 +743,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -669,15 +781,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -696,15 +813,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -729,15 +851,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -770,7 +897,9 @@ "events" : [ { "name" : "beforetoggle", + "type" : "function", "desc" : "Fire before toggle the menu", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Navbar", "example" : "", "deprecated" : "", @@ -788,7 +917,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -806,7 +937,9 @@ }, { "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" : "", @@ -824,7 +957,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -842,7 +977,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -860,7 +997,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -878,7 +1017,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -896,7 +1037,9 @@ }, { "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" : "", @@ -914,7 +1057,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -932,7 +1077,9 @@ }, { "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" : "", @@ -950,7 +1097,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -968,7 +1117,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.NavSidebarItem.json b/docs/symbols/Roo.bootstrap.NavSidebarItem.json index 6c4da09f5e..c20d344e4a 100644 --- a/docs/symbols/Roo.bootstrap.NavSidebarItem.json +++ b/docs/symbols/Roo.bootstrap.NavSidebarItem.json @@ -24,260 +24,207 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "animateRef", "type" : "Boolean", "desc" : "e) link to element default false", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.NavItem" }, { "name" : "linkcls", "type" : "String", "desc" : "Link Class", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [] + "memberOf" : "Roo.bootstrap.NavItem" }, { "name" : "tagtype", "type" : "String", "desc" : "n) render as a href or span?", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [ - "a", - "span" - ] + "memberOf" : "Roo.bootstrap.NavItem" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "tabId", "type" : "String", "desc" : "the tab that this item activates.", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [] + "memberOf" : "Roo.bootstrap.NavItem" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "badge", "type" : "String", "desc" : "text inside badge", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [] + "memberOf" : "Roo.bootstrap.NavItem" }, { "name" : "disabled", "type" : "Boolean", "desc" : "Is item disabled", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [] + "memberOf" : "Roo.bootstrap.NavItem" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "button_outline", "type" : "Boolean", "desc" : "show and outlined button", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [] + "memberOf" : "Roo.bootstrap.NavItem" }, { "name" : "html", "type" : "String", "desc" : "content of button", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [] + "memberOf" : "Roo.bootstrap.NavItem" }, { "name" : "preventDefault", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.NavItem" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "glyphicon", "type" : "String", "desc" : "DEPRICATED - use fa", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [] + "memberOf" : "Roo.bootstrap.NavItem" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "icon", "type" : "String", "desc" : "DEPRICATED - use fa", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [] + "memberOf" : "Roo.bootstrap.NavItem" }, { "name" : "badgecls", "type" : "String", "desc" : "w)the extra classes for the badge", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [ - "bg-green", - "bg-red", - "bg-yellow" - ] + "memberOf" : "Roo.bootstrap.NavItem" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "button_weight", "type" : "String", "desc" : "k) default none", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [ - "default", - "primary", - "secondary", - "success", - "info", - "warning", - "danger", - "link", - "light", - "dark" - ] + "memberOf" : "Roo.bootstrap.NavItem" }, { "name" : "fa", "type" : "String", "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [] + "memberOf" : "Roo.bootstrap.NavItem" }, { "name" : "active", "type" : "Boolean", "desc" : "Is item active", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [] + "memberOf" : "Roo.bootstrap.NavItem" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "href", "type" : "String", "desc" : "link to", - "memberOf" : "Roo.bootstrap.NavItem", - "optvals" : [] + "memberOf" : "Roo.bootstrap.NavItem" } ], "methods" : [ { "name" : "tooltipEl", + "type" : "function", "desc" : "Fetch the element to display the tooltip on.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.NavItem", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.NavItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -289,15 +236,20 @@ }, { "name" : "setHtml", + "type" : "function", "desc" : "Set the HTML (text content) of the item", + "sig" : "(html)", + "static" : false, + "memberOf" : "Roo.bootstrap.NavItem", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.NavItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "html", @@ -310,85 +262,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -400,15 +382,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -420,15 +407,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -441,43 +433,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -490,15 +497,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -517,15 +529,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -537,15 +554,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -564,15 +586,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -584,15 +611,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -604,29 +636,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -657,15 +699,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -690,15 +737,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -711,15 +763,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -732,15 +789,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -765,15 +827,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -798,15 +865,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -825,15 +897,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -858,15 +935,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -899,8 +981,10 @@ "events" : [ { "name" : "changed", + "type" : "function", "desc" : "Fires when the active item active state changes", - "memberOf" : "Roo.bootstrap.NavSidebarItem", + "sig" : "function (_self, state)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -923,8 +1007,10 @@ }, { "name" : "click", + "type" : "function", "desc" : "The raw click event for the entire grid.", - "memberOf" : "Roo.bootstrap.NavSidebarItem", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -941,7 +1027,9 @@ }, { "name" : "scrollto", + "type" : "function", "desc" : "Fires when scroll to element", + "sig" : "function (_self, options, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.NavItem", "example" : "", "deprecated" : "", @@ -971,7 +1059,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -989,7 +1079,9 @@ }, { "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" : "", @@ -1007,7 +1099,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1025,7 +1119,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1043,7 +1139,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1061,7 +1159,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1079,7 +1179,9 @@ }, { "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" : "", @@ -1097,7 +1199,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1115,7 +1219,9 @@ }, { "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" : "", @@ -1133,7 +1239,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1151,7 +1259,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.NavSimplebar.json b/docs/symbols/Roo.bootstrap.NavSimplebar.json index 7d5d2e36fb..e7616861b2 100644 --- a/docs/symbols/Roo.bootstrap.NavSimplebar.json +++ b/docs/symbols/Roo.bootstrap.NavSimplebar.json @@ -24,236 +24,197 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "inverse", "type" : "Boolean", "desc" : "is inverted color", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [] + "memberOf" : "" }, { "name" : "align", "type" : "String", "desc" : "t) alignment", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "tag", "type" : "String", "desc" : "v) default is nav", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "header", - "footer", - "nav", - "div" - ] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "arrangement", "type" : "Boolean", "desc" : "stacked | justified", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [] + "memberOf" : "" }, { "name" : "loadMask", "type" : "Boolean", "desc" : "e) loadMask on the bar", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "main", "type" : "Boolean", "desc" : "e) main nav bar? default false", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "type", "type" : "String", "desc" : "s)", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "nav", - "pills", - "tabs" - ] + "memberOf" : "" }, { "name" : "weight", "type" : "String", "desc" : "e) default is light.", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "light", - "primary", - "secondary", - "success", - "danger", - "warning", - "info", - "dark", - "white" - ] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "collapse", + "type" : "function", "desc" : "Collapse the navbar pulldown", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Navbar", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Navbar", "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.Navbar", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Navbar", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -265,85 +226,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -355,15 +346,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -375,15 +371,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -396,43 +397,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -445,15 +461,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -472,15 +493,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -492,15 +518,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -519,15 +550,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -539,15 +575,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -559,29 +600,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -612,15 +663,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -645,15 +701,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -666,15 +727,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -687,15 +753,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -720,15 +791,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -753,15 +829,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -780,15 +861,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -813,15 +899,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -854,7 +945,9 @@ "events" : [ { "name" : "beforetoggle", + "type" : "function", "desc" : "Fire before toggle the menu", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Navbar", "example" : "", "deprecated" : "", @@ -872,7 +965,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -890,7 +985,9 @@ }, { "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" : "", @@ -908,7 +1005,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -926,7 +1025,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -944,7 +1045,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -962,7 +1065,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -980,7 +1085,9 @@ }, { "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" : "", @@ -998,7 +1105,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1016,7 +1125,9 @@ }, { "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" : "", @@ -1034,7 +1145,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1052,7 +1165,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Navbar.json b/docs/symbols/Roo.bootstrap.Navbar.json index fa5353fc3e..f745cb03b5 100644 --- a/docs/symbols/Roo.bootstrap.Navbar.json +++ b/docs/symbols/Roo.bootstrap.Navbar.json @@ -23,152 +23,149 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Navbar", "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, - "memberOf" : "Roo.bootstrap.Navbar", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -180,85 +177,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -270,15 +297,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -290,15 +322,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -311,43 +348,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -360,15 +412,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -387,15 +444,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -407,15 +469,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -434,15 +501,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -454,15 +526,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -474,29 +551,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -527,15 +614,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -560,15 +652,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -581,15 +678,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -602,15 +704,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -635,15 +742,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -668,15 +780,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -695,15 +812,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -728,15 +850,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -769,8 +896,10 @@ "events" : [ { "name" : "beforetoggle", + "type" : "function", "desc" : "Fire before toggle the menu", - "memberOf" : "Roo.bootstrap.Navbar", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -787,7 +916,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -805,7 +936,9 @@ }, { "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" : "", @@ -823,7 +956,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -841,7 +976,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -859,7 +996,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -877,7 +1016,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -895,7 +1036,9 @@ }, { "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" : "", @@ -913,7 +1056,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -931,7 +1076,9 @@ }, { "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" : "", @@ -949,7 +1096,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -967,7 +1116,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.NumberField.json b/docs/symbols/Roo.bootstrap.NumberField.json index 105129b7ab..8b71cf79d0 100644 --- a/docs/symbols/Roo.bootstrap.NumberField.json +++ b/docs/symbols/Roo.bootstrap.NumberField.json @@ -24,588 +24,496 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "validFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "lg", "type" : "Number", "desc" : "colspan out of 12 for large computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)", "type" : "String", "desc" : "inputType", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xs", "type" : "Number", "desc" : "colspan out of 12 for mobile-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "disabled", "type" : "Boolean", "desc" : "is it disabled", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "name", "type" : "String", "desc" : "name of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "autocomplete", "type" : "String", "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "nanText", "type" : "String", "desc" : "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")", - "memberOf" : "Roo.bootstrap.NumberField", - "optvals" : [] + "memberOf" : "" }, { "name" : "regexText", "type" : "String", "desc" : "-- Depricated - use Invalid Text", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxValue", "type" : "Number", "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.bootstrap.NumberField", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "minValue", "type" : "Number", "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)", - "memberOf" : "Roo.bootstrap.NumberField", - "optvals" : [] + "memberOf" : "" }, { "name" : "decimalPrecision", "type" : "Number", "desc" : "The maximum precision to display after the decimal separator (defaults to 2)", - "memberOf" : "Roo.bootstrap.NumberField", - "optvals" : [] + "memberOf" : "" }, { "name" : "minText", "type" : "String", "desc" : "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")", - "memberOf" : "Roo.bootstrap.NumberField", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "labelmd", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "value", "type" : "string", "desc" : "default value of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "sm", "type" : "Number", "desc" : "colspan out of 12 for tablet-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "Specifies that the field should be read-only", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowDecimals", "type" : "Boolean", "desc" : "False to disallow decimal values (defaults to true)", - "memberOf" : "Roo.bootstrap.NumberField", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowNegative", "type" : "Boolean", "desc" : "False to prevent entering a negative sign (defaults to true)", - "memberOf" : "Roo.bootstrap.NumberField", - "optvals" : [] + "memberOf" : "" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "size", "type" : "string", "desc" : "- (lg|sm) or leave empty..", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labellg", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelxs", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "invalidClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "valueAlign", "type" : "String", "desc" : "alignment of value", - "memberOf" : "Roo.bootstrap.NumberField", - "optvals" : [] + "memberOf" : "" }, { "name" : "fieldLabel", "type" : "string", "desc" : "- the label associated", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "before", "type" : "string", "desc" : "- input group add on before", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "thousandsDelimiter", "type" : "String", "desc" : "Symbol of thousandsDelimiter", - "memberOf" : "Roo.bootstrap.NumberField", - "optvals" : [] + "memberOf" : "" }, { "name" : "invalidFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "decimalSeparator", "type" : "String", "desc" : "Character(s) to allow as the decimal separator (defaults to '.')", - "memberOf" : "Roo.bootstrap.NumberField", - "optvals" : [] + "memberOf" : "" }, { "name" : "placeholder", "type" : "string", "desc" : "- placeholder to put in text.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "md", "type" : "Number", "desc" : "colspan out of 12 for computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", "type" : "Number", "desc" : "set the width of label", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxText", "type" : "String", "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")", - "memberOf" : "Roo.bootstrap.NumberField", - "optvals" : [] + "memberOf" : "" }, { "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "preventMark", "type" : "Boolean", "desc" : "Do not show tick or cross if error/success", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelsm", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "after", "type" : "string", "desc" : "- input group add on after", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowZero", "type" : "Boolean", "desc" : "False to blank out if the user enters '0' (defaults to true)", - "memberOf" : "Roo.bootstrap.NumberField", - "optvals" : [] + "memberOf" : "" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" } ], "methods" : [ { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -617,15 +525,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -638,15 +551,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -658,29 +576,39 @@ }, { "name" : "markValid", + "type" : "function", "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -692,29 +620,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -726,15 +664,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -747,15 +690,20 @@ }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -768,29 +716,39 @@ }, { "name" : "inputEl", + "type" : "function", "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -809,15 +767,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -829,85 +792,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -919,15 +912,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -939,15 +937,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -960,43 +963,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -1009,15 +1027,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -1036,15 +1059,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1056,15 +1084,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1083,15 +1116,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1103,15 +1141,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1123,29 +1166,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1176,15 +1229,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1209,15 +1267,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1230,15 +1293,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1251,15 +1319,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1284,15 +1357,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1317,15 +1395,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1344,15 +1427,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1377,15 +1465,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1418,7 +1511,9 @@ "events" : [ { "name" : "paste", + "type" : "function", "desc" : "Fires after the user pastes into input", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1442,7 +1537,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1472,7 +1569,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1496,7 +1595,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1514,7 +1615,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1532,7 +1635,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1556,7 +1661,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1574,7 +1681,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1598,7 +1707,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1616,7 +1727,9 @@ }, { "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" : "", @@ -1634,7 +1747,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1652,7 +1767,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1670,7 +1787,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1688,7 +1807,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1706,7 +1827,9 @@ }, { "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" : "", @@ -1724,7 +1847,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1742,7 +1867,9 @@ }, { "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" : "", @@ -1760,7 +1887,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1778,7 +1907,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Pagination.json b/docs/symbols/Roo.bootstrap.Pagination.json index f2476ff0c4..4c0250e40e 100644 --- a/docs/symbols/Roo.bootstrap.Pagination.json +++ b/docs/symbols/Roo.bootstrap.Pagination.json @@ -23,138 +23,123 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "inverse", "type" : "Boolean", "desc" : "false | true", - "memberOf" : "Roo.bootstrap.Pagination", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "size", "type" : "String", "desc" : "xs | sm | md | lg", - "memberOf" : "Roo.bootstrap.Pagination", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -166,85 +151,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -256,15 +271,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -276,15 +296,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -297,43 +322,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -346,15 +386,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -373,15 +418,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -393,15 +443,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -420,15 +475,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -440,15 +500,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -460,29 +525,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -513,15 +588,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -546,15 +626,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -567,15 +652,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -588,15 +678,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -621,15 +716,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -654,15 +754,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -681,15 +786,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -714,15 +824,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -755,7 +870,9 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -773,7 +890,9 @@ }, { "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" : "", @@ -791,7 +910,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -809,7 +930,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -827,7 +950,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -845,7 +970,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -863,7 +990,9 @@ }, { "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" : "", @@ -881,7 +1010,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -899,7 +1030,9 @@ }, { "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" : "", @@ -917,7 +1050,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -935,7 +1070,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.PaginationItem.json b/docs/symbols/Roo.bootstrap.PaginationItem.json index 52ba450708..4591e2b0b5 100644 --- a/docs/symbols/Roo.bootstrap.PaginationItem.json +++ b/docs/symbols/Roo.bootstrap.PaginationItem.json @@ -23,165 +23,141 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disabled", "type" : "Boolean", "desc" : "default false", - "memberOf" : "Roo.bootstrap.PaginationItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "preventDefault", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.PaginationItem", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "html", "type" : "String", "desc" : "text", - "memberOf" : "Roo.bootstrap.PaginationItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "active", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.PaginationItem", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "href", "type" : "String", "desc" : "the link", - "memberOf" : "Roo.bootstrap.PaginationItem", - "optvals" : [] + "memberOf" : "" } ], "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -193,85 +169,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -283,15 +289,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -303,15 +314,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -324,43 +340,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -373,15 +404,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -400,15 +436,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -420,15 +461,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -447,15 +493,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -467,15 +518,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -487,29 +543,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -540,15 +606,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -573,15 +644,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -594,15 +670,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -615,15 +696,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -648,15 +734,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -681,15 +772,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -708,15 +804,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -741,15 +842,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -782,8 +888,10 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "The raw click event for the entire grid.", - "memberOf" : "Roo.bootstrap.PaginationItem", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -800,7 +908,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -818,7 +928,9 @@ }, { "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" : "", @@ -836,7 +948,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -854,7 +968,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -872,7 +988,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -890,7 +1008,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -908,7 +1028,9 @@ }, { "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" : "", @@ -926,7 +1048,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -944,7 +1068,9 @@ }, { "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" : "", @@ -962,7 +1088,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -980,7 +1108,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.PagingToolbar.json b/docs/symbols/Roo.bootstrap.PagingToolbar.json index e8794378bc..79762aecab 100644 --- a/docs/symbols/Roo.bootstrap.PagingToolbar.json +++ b/docs/symbols/Roo.bootstrap.PagingToolbar.json @@ -31,250 +31,195 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "inverse", "type" : "Boolean", "desc" : "is inverted color", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "align", "type" : "String", "desc" : "t) alignment", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "pageSize", "type" : "Number", "desc" : "The number of records to display per page (defaults to 20)", - "memberOf" : "Roo.bootstrap.PagingToolbar", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "tag", "type" : "String", "desc" : "v) default is nav", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "header", - "footer", - "nav", - "div" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataSource", "type" : "Roo.data.Store", "desc" : "The underlying data store providing the paged data", - "memberOf" : "Roo.bootstrap.PagingToolbar", - "optvals" : [] + "memberOf" : "" }, { "name" : "container", "type" : "String/HTMLElement/Element", "desc" : "container The id or element that will contain the toolbar", - "memberOf" : "Roo.bootstrap.PagingToolbar", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "arrangement", "type" : "Boolean", "desc" : "stacked | justified", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "loadMask", "type" : "Boolean", "desc" : "e) loadMask on the bar", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "emptyMsg", "type" : "String", "desc" : "The message to display when no records are found (defaults to \"No data to display\")", - "memberOf" : "Roo.bootstrap.PagingToolbar", - "optvals" : [] + "memberOf" : "" }, { "name" : "main", "type" : "Boolean", "desc" : "e) main nav bar? default false", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "displayInfo", "type" : "Boolean", "desc" : "True to display the displayMsg (defaults to false)", - "memberOf" : "Roo.bootstrap.PagingToolbar", - "optvals" : [] + "memberOf" : "" }, { "name" : "displayMsg", "type" : "String", "desc" : "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")", - "memberOf" : "Roo.bootstrap.PagingToolbar", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "type", "type" : "String", "desc" : "s)", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "nav", - "pills", - "tabs" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "weight", "type" : "String", "desc" : "e) default is light.", - "memberOf" : "Roo.bootstrap.NavSimplebar", - "optvals" : [ - "light", - "primary", - "secondary", - "success", - "danger", - "warning", - "info", - "dark", - "white" - ] + "memberOf" : "Roo.bootstrap.NavSimplebar" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "unbind", + "type" : "function", "desc" : "Unbinds the paging toolbar from the specified {@link Roo.data.Store}", + "sig" : "(store)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.PagingToolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "store", @@ -287,15 +232,20 @@ }, { "name" : "bind", + "type" : "function", "desc" : "Binds the paging toolbar to the specified {@link Roo.data.Store}", + "sig" : "(store)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.PagingToolbar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "store", @@ -308,43 +258,58 @@ }, { "name" : "collapse", + "type" : "function", "desc" : "Collapse the navbar pulldown", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Navbar", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Navbar", "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.Navbar", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Navbar", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -356,85 +321,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -446,15 +441,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -466,15 +466,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -487,43 +492,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -536,15 +556,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -563,15 +588,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -583,15 +613,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -610,15 +645,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -630,15 +670,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -650,29 +695,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -703,15 +758,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -736,15 +796,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -757,15 +822,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -778,15 +848,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -811,15 +886,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -844,15 +924,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -871,15 +956,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -904,15 +994,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -945,7 +1040,9 @@ "events" : [ { "name" : "beforetoggle", + "type" : "function", "desc" : "Fire before toggle the menu", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Navbar", "example" : "", "deprecated" : "", @@ -963,7 +1060,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -981,7 +1080,9 @@ }, { "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" : "", @@ -999,7 +1100,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1017,7 +1120,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1035,7 +1140,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1053,7 +1160,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1071,7 +1180,9 @@ }, { "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" : "", @@ -1089,7 +1200,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1107,7 +1220,9 @@ }, { "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" : "", @@ -1125,7 +1240,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1143,7 +1260,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.PhoneInput.json b/docs/symbols/Roo.bootstrap.PhoneInput.json index 8d6ea22ce7..cfd92b4cb5 100644 --- a/docs/symbols/Roo.bootstrap.PhoneInput.json +++ b/docs/symbols/Roo.bootstrap.PhoneInput.json @@ -25,538 +25,447 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "triggerClass", "type" : "String", "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be appended if specified.", - "memberOf" : "Roo.bootstrap.TriggerField", - "optvals" : [] + "memberOf" : "Roo.bootstrap.TriggerField" }, { "name" : "validFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "lg", "type" : "Number", "desc" : "colspan out of 12 for large computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)", "type" : "String", "desc" : "inputType", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xs", "type" : "Number", "desc" : "colspan out of 12 for mobile-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "disabled", "type" : "Boolean", "desc" : "is it disabled", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "name", "type" : "String", "desc" : "name of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "autocomplete", "type" : "String", "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "regexText", "type" : "String", "desc" : "-- Depricated - use Invalid Text", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "labelmd", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "value", "type" : "string", "desc" : "default value of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" + }, + { + "name" : "store", + "type" : "Roo.data.Store", + "desc" : "[required] The data store to which this combo is bound (defaults to undefined)", + "memberOf" : "" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "sm", "type" : "Number", "desc" : "colspan out of 12 for tablet-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "Specifies that the field should be read-only", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "size", "type" : "string", "desc" : "- (lg|sm) or leave empty..", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labellg", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hideTrigger", "type" : "Boolean", "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", - "memberOf" : "Roo.bootstrap.TriggerField", - "optvals" : [] + "memberOf" : "Roo.bootstrap.TriggerField" }, { "name" : "removable", "type" : "Boolean", "desc" : "e) special filter default false", - "memberOf" : "Roo.bootstrap.TriggerField", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.TriggerField" }, { "name" : "labelxs", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "caret", "type" : "String", "desc" : "r) BS3 only - carat fa name", - "memberOf" : "Roo.bootstrap.TriggerField", - "optvals" : [ - "search", - "calendar" - ] + "memberOf" : "Roo.bootstrap.TriggerField" }, { "name" : "invalidClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "fieldLabel", "type" : "string", "desc" : "- the label associated", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "before", "type" : "string", "desc" : "- input group add on before", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "invalidFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "defaultDialCode", "type" : "String", "desc" : "default '+852'", - "memberOf" : "Roo.bootstrap.PhoneInput", - "optvals" : [] + "memberOf" : "" }, { "name" : "placeholder", "type" : "string", "desc" : "- placeholder to put in text.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "md", "type" : "Number", "desc" : "colspan out of 12 for computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", "type" : "Number", "desc" : "set the width of label", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "preferedCountries", "type" : "Array", "desc" : "default []", - "memberOf" : "Roo.bootstrap.PhoneInput", - "optvals" : [] + "memberOf" : "" }, { "name" : "preventMark", "type" : "Boolean", "desc" : "Do not show tick or cross if error/success", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelsm", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "after", "type" : "string", "desc" : "- input group add on after", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" } ], "methods" : [ { "name" : "onTriggerClick", + "type" : "function", "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.bootstrap.TriggerField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TriggerField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -569,43 +478,58 @@ }, { "name" : "autoSize", + "type" : "function", "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.TriggerField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TriggerField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -617,15 +541,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -638,15 +567,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -658,29 +592,39 @@ }, { "name" : "markValid", + "type" : "function", "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -692,29 +636,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -726,15 +680,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -747,15 +706,20 @@ }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -768,29 +732,39 @@ }, { "name" : "inputEl", + "type" : "function", "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -809,15 +783,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -829,85 +808,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -919,15 +928,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -939,15 +953,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -960,43 +979,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -1009,15 +1043,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -1036,15 +1075,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1056,15 +1100,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1083,15 +1132,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1103,15 +1157,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1123,29 +1182,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1176,15 +1245,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1209,15 +1283,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1230,15 +1309,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1251,15 +1335,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1284,15 +1373,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1317,15 +1411,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1344,15 +1443,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1377,15 +1481,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1418,7 +1527,9 @@ "events" : [ { "name" : "paste", + "type" : "function", "desc" : "Fires after the user pastes into input", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1442,7 +1553,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1472,7 +1585,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1496,7 +1611,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1514,7 +1631,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1532,7 +1651,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1556,7 +1677,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1574,7 +1697,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1598,7 +1723,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1616,7 +1743,9 @@ }, { "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" : "", @@ -1634,7 +1763,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1652,7 +1783,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1670,7 +1803,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1688,7 +1823,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1706,7 +1843,9 @@ }, { "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" : "", @@ -1724,7 +1863,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1742,7 +1883,9 @@ }, { "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" : "", @@ -1760,7 +1903,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1778,7 +1923,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Popover.json b/docs/symbols/Roo.bootstrap.Popover.json index c2bee85eb0..db4ec46a8a 100644 --- a/docs/symbols/Roo.bootstrap.Popover.json +++ b/docs/symbols/Roo.bootstrap.Popover.json @@ -23,173 +23,153 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "modal", "type" : "Boolean", "desc" : "- popovers that are modal will mask the screen, and must be closed with another event.", - "memberOf" : "Roo.bootstrap.Popover", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "add", "type" : "String|Boolean|Roo.Element", "desc" : "click hander to trigger show over what element\n - if false and it has a 'parent' then it will be automatically added to that element\n - if string - Roo.get will be called", - "memberOf" : "Roo.bootstrap.Popover", - "optvals" : [] + "memberOf" : "" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "delay", "type" : "Number", "desc" : "- delay before showing", - "memberOf" : "Roo.bootstrap.Popover", - "optvals" : [] + "memberOf" : "" }, { "name" : "trigger", "type" : "String", "desc" : "click || hover (or false to trigger manually)", - "memberOf" : "Roo.bootstrap.Popover", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "title", "type" : "String", "desc" : "of popover (or false to hide)", - "memberOf" : "Roo.bootstrap.Popover", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "(right|top|bottom|left|auto)", "type" : "String|function", "desc" : "placement how it is placed", - "memberOf" : "Roo.bootstrap.Popover", - "optvals" : [] + "memberOf" : "" }, { "name" : "html", "type" : "String", "desc" : "contents of the popover (or false to use children..)", - "memberOf" : "Roo.bootstrap.Popover", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "setContent", + "type" : "function", "desc" : "", + "sig" : "(the)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Popover", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -202,15 +182,20 @@ }, { "name" : "setTitle", + "type" : "function", "desc" : "", + "sig" : "(the)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Popover", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -223,15 +208,20 @@ }, { "name" : "updatePosition", + "type" : "function", "desc" : "fire this manually after loading a grid in the table for example", + "sig" : "((left|right|top|bottom), try)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Popover", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "(left|right|top|bottom)", @@ -250,15 +240,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show the popover", + "sig" : "(-, (left|right|top|bottom))", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Popover", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "-", @@ -277,15 +272,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -297,71 +297,96 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -373,15 +398,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -393,15 +423,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -414,43 +449,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -463,15 +513,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -490,15 +545,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -510,15 +570,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -537,15 +602,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -557,15 +627,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -577,29 +652,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -630,15 +715,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -663,15 +753,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -684,15 +779,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -705,15 +805,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -738,15 +843,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -771,15 +881,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -798,15 +913,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -831,15 +951,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -872,8 +997,10 @@ "events" : [ { "name" : "hide", + "type" : "function", "desc" : "After the popover hide", - "memberOf" : "Roo.bootstrap.Popover", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -890,8 +1017,10 @@ }, { "name" : "show", + "type" : "function", "desc" : "After the popover show", - "memberOf" : "Roo.bootstrap.Popover", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -908,7 +1037,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -926,7 +1057,9 @@ }, { "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" : "", @@ -944,7 +1077,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -962,7 +1097,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -980,7 +1117,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -998,7 +1137,9 @@ }, { "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" : "", @@ -1016,7 +1157,9 @@ }, { "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" : "", @@ -1034,7 +1177,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1052,7 +1197,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.PopoverNav.json b/docs/symbols/Roo.bootstrap.PopoverNav.json index fecd0acc83..b52024d3cd 100644 --- a/docs/symbols/Roo.bootstrap.PopoverNav.json +++ b/docs/symbols/Roo.bootstrap.PopoverNav.json @@ -24,166 +24,141 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "pilltype", "type" : "Boolean", "desc" : "default true (turn to off to disable active toggle)", - "memberOf" : "Roo.bootstrap.NavGroup", - "optvals" : [] + "memberOf" : "Roo.bootstrap.NavGroup" }, { "name" : "align", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.NavGroup", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.NavGroup" }, { "name" : "inverse", "type" : "Boolean", "desc" : "", - "memberOf" : "Roo.bootstrap.NavGroup", - "optvals" : [] + "memberOf" : "Roo.bootstrap.NavGroup" }, { "name" : "navId", "type" : "String", "desc" : "- reference Id for navbar.", - "memberOf" : "Roo.bootstrap.NavGroup", - "optvals" : [] + "memberOf" : "Roo.bootstrap.NavGroup" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "type", "type" : "String", "desc" : "b) default nav", - "memberOf" : "Roo.bootstrap.NavGroup", - "optvals" : [ - "nav", - "pills", - "tab" - ] + "memberOf" : "Roo.bootstrap.NavGroup" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "register", + "type" : "function", "desc" : "register a Navigation item", + "sig" : "(the)", + "static" : false, + "memberOf" : "Roo.bootstrap.NavGroup", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.NavGroup", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -196,15 +171,20 @@ }, { "name" : "getActive", + "type" : "function", "desc" : "gets the active Navigation item", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.NavGroup", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.NavGroup", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -216,15 +196,20 @@ }, { "name" : "addItem", + "type" : "function", "desc" : "adds a Navigation item", + "sig" : "(the)", + "static" : false, + "memberOf" : "Roo.bootstrap.NavGroup", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.NavGroup", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -237,15 +222,20 @@ }, { "name" : "get", + "type" : "function", "desc" : "fetch a Navigation Group based on the navigation ID", + "sig" : "(the)", + "static" : true, + "memberOf" : "Roo.bootstrap.NavGroup", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.NavGroup", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -258,15 +248,20 @@ }, { "name" : "setActiveItem", + "type" : "function", "desc" : "sets the active Navigation item", + "sig" : "(the)", + "static" : false, + "memberOf" : "Roo.bootstrap.NavGroup", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.NavGroup", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -279,29 +274,39 @@ }, { "name" : "clearAll", + "type" : "function", "desc" : "clear all the Navigation item", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.NavGroup", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.NavGroup", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -313,85 +318,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -403,15 +438,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -423,15 +463,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -444,43 +489,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -493,15 +553,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -520,15 +585,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -540,15 +610,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -567,15 +642,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -587,15 +667,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -607,29 +692,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -660,15 +755,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -693,15 +793,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -714,15 +819,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -735,15 +845,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -768,15 +883,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -801,15 +921,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -828,15 +953,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -861,15 +991,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -902,7 +1037,9 @@ "events" : [ { "name" : "changed", + "type" : "function", "desc" : "Fires when the active item changes", + "sig" : "function (_self, selected, prev)\n{\n\n}", "memberOf" : "Roo.bootstrap.NavGroup", "example" : "", "deprecated" : "", @@ -932,7 +1069,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -950,7 +1089,9 @@ }, { "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" : "", @@ -968,7 +1109,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -986,7 +1129,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1004,7 +1149,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1022,7 +1169,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1040,7 +1189,9 @@ }, { "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" : "", @@ -1058,7 +1209,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1076,7 +1229,9 @@ }, { "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" : "", @@ -1094,7 +1249,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1112,7 +1269,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Progress.json b/docs/symbols/Roo.bootstrap.Progress.json index 8387b16ba3..6a59fc8552 100644 --- a/docs/symbols/Roo.bootstrap.Progress.json +++ b/docs/symbols/Roo.bootstrap.Progress.json @@ -23,138 +23,123 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "striped", "type" : "Boolean", "desc" : "striped of the progress bar", - "memberOf" : "Roo.bootstrap.Progress", - "optvals" : [] + "memberOf" : "" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "active", "type" : "Boolean", "desc" : "animated of the progress bar", - "memberOf" : "Roo.bootstrap.Progress", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -166,85 +151,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -256,15 +271,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -276,15 +296,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -297,43 +322,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -346,15 +386,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -373,15 +418,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -393,15 +443,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -420,15 +475,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -440,15 +500,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -460,29 +525,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -513,15 +588,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -546,15 +626,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -567,15 +652,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -588,15 +678,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -621,15 +716,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -654,15 +754,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -681,15 +786,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -714,15 +824,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -755,7 +870,9 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -773,7 +890,9 @@ }, { "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" : "", @@ -791,7 +910,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -809,7 +930,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -827,7 +950,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -845,7 +970,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -863,7 +990,9 @@ }, { "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" : "", @@ -881,7 +1010,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -899,7 +1030,9 @@ }, { "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" : "", @@ -917,7 +1050,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -935,7 +1070,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.ProgressBar.json b/docs/symbols/Roo.bootstrap.ProgressBar.json index 883ea7daf4..f0a447516b 100644 --- a/docs/symbols/Roo.bootstrap.ProgressBar.json +++ b/docs/symbols/Roo.bootstrap.ProgressBar.json @@ -23,178 +23,153 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "label", "type" : "String", "desc" : "label for the progress bar", - "memberOf" : "Roo.bootstrap.ProgressBar", - "optvals" : [] + "memberOf" : "" }, { "name" : "panel", "type" : "String", "desc" : ")", - "memberOf" : "Roo.bootstrap.ProgressBar", - "optvals" : [ - "success", - "info", - "warning", - "danger" - ] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "aria_valuenow", "type" : "Number", "desc" : "aria-value now", - "memberOf" : "Roo.bootstrap.ProgressBar", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "aria_valuemax", "type" : "Number", "desc" : "aria-value max", - "memberOf" : "Roo.bootstrap.ProgressBar", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "aria_valuemin", "type" : "Number", "desc" : "aria-value min", - "memberOf" : "Roo.bootstrap.ProgressBar", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "role", "type" : "String", "desc" : "role of the progress bar", - "memberOf" : "Roo.bootstrap.ProgressBar", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "sr_only", "type" : "String", "desc" : "text", - "memberOf" : "Roo.bootstrap.ProgressBar", - "optvals" : [] + "memberOf" : "" } ], "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -206,85 +181,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -296,15 +301,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -316,15 +326,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -337,43 +352,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -386,15 +416,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -413,15 +448,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -433,15 +473,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -460,15 +505,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -480,15 +530,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -500,29 +555,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -553,15 +618,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -586,15 +656,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -607,15 +682,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -628,15 +708,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -661,15 +746,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -694,15 +784,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -721,15 +816,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -754,15 +854,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -795,7 +900,9 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -813,7 +920,9 @@ }, { "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" : "", @@ -831,7 +940,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -849,7 +960,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -867,7 +980,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -885,7 +1000,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -903,7 +1020,9 @@ }, { "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" : "", @@ -921,7 +1040,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -939,7 +1060,9 @@ }, { "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" : "", @@ -957,7 +1080,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -975,7 +1100,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Radio.json b/docs/symbols/Roo.bootstrap.Radio.json index aed55d1229..02f2e8722f 100644 --- a/docs/symbols/Roo.bootstrap.Radio.json +++ b/docs/symbols/Roo.bootstrap.Radio.json @@ -23,138 +23,123 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "value", "type" : "String", "desc" : "- the value of radio", - "memberOf" : "Roo.bootstrap.Radio", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "boxLabel", "type" : "String", "desc" : "- the label associated", - "memberOf" : "Roo.bootstrap.Radio", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -166,85 +151,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -256,15 +271,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -276,15 +296,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -297,43 +322,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -346,15 +386,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -373,15 +418,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -393,15 +443,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -420,15 +475,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -440,15 +500,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -460,29 +525,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -513,15 +588,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -546,15 +626,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -567,15 +652,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -588,15 +678,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -621,15 +716,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -654,15 +754,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -681,15 +786,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -714,15 +824,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -755,7 +870,9 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -773,7 +890,9 @@ }, { "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" : "", @@ -791,7 +910,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -809,7 +930,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -827,7 +950,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -845,7 +970,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -863,7 +990,9 @@ }, { "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" : "", @@ -881,7 +1010,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -899,7 +1030,9 @@ }, { "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" : "", @@ -917,7 +1050,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -935,7 +1070,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.RadioSet.json b/docs/symbols/Roo.bootstrap.RadioSet.json index 2f1b9d96fc..b8f532f0b5 100644 --- a/docs/symbols/Roo.bootstrap.RadioSet.json +++ b/docs/symbols/Roo.bootstrap.RadioSet.json @@ -24,527 +24,436 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "validFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "lg", "type" : "Number", "desc" : "colspan out of 12 for large computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)", "type" : "String", "desc" : "inputType", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xs", "type" : "Number", "desc" : "colspan out of 12 for mobile-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "disabled", "type" : "Boolean", "desc" : "is it disabled", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "name", "type" : "String", "desc" : "name of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "weight", "type" : "String", "desc" : "s) The text that appears beside the radio", - "memberOf" : "Roo.bootstrap.RadioSet", - "optvals" : [ - "primary", - "warning", - "info", - "danger", - "success" - ] + "memberOf" : "" }, { "name" : "autocomplete", "type" : "String", "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "regexText", "type" : "String", "desc" : "-- Depricated - use Invalid Text", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "labelmd", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "value", "type" : "string", "desc" : "default value of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "sm", "type" : "Number", "desc" : "colspan out of 12 for tablet-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "Specifies that the field should be read-only", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.RadioSet", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "" }, { "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "inline", "type" : "Boolean", "desc" : "e) inline the element (default true)", - "memberOf" : "Roo.bootstrap.RadioSet", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "size", "type" : "string", "desc" : "- (lg|sm) or leave empty..", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labellg", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelxs", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "invalidClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "fieldLabel", "type" : "string", "desc" : "- the label associated", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "before", "type" : "string", "desc" : "- input group add on before", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "invalidFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "placeholder", "type" : "string", "desc" : "- placeholder to put in text.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "md", "type" : "Number", "desc" : "colspan out of 12 for computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", "type" : "Number", "desc" : "set the width of label", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "preventMark", "type" : "Boolean", "desc" : "Do not show tick or cross if error/success", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelsm", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "after", "type" : "string", "desc" : "- input group add on after", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" } ], "methods" : [ { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -556,15 +465,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -577,15 +491,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -597,29 +516,39 @@ }, { "name" : "markValid", + "type" : "function", "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -631,29 +560,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -665,15 +604,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -686,15 +630,20 @@ }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -707,29 +656,39 @@ }, { "name" : "inputEl", + "type" : "function", "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -748,15 +707,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -768,85 +732,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -858,15 +852,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -878,15 +877,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -899,43 +903,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -948,15 +967,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -975,15 +999,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -995,15 +1024,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1022,15 +1056,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1042,15 +1081,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1062,29 +1106,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1115,15 +1169,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1148,15 +1207,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1169,15 +1233,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1190,15 +1259,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1223,15 +1297,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1256,15 +1335,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1283,15 +1367,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1316,15 +1405,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1357,8 +1451,10 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "Fires when the element is click.", - "memberOf" : "Roo.bootstrap.RadioSet", + "sig" : "function (_self, item, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1387,8 +1483,10 @@ }, { "name" : "check", + "type" : "function", "desc" : "Fires when the element is checked or unchecked.", - "memberOf" : "Roo.bootstrap.RadioSet", + "sig" : "function (_self, item)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1411,7 +1509,9 @@ }, { "name" : "paste", + "type" : "function", "desc" : "Fires after the user pastes into input", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1435,7 +1535,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1465,7 +1567,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1489,7 +1593,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1507,7 +1613,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1525,7 +1633,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1549,7 +1659,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1567,7 +1679,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1591,7 +1705,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1609,7 +1725,9 @@ }, { "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" : "", @@ -1627,7 +1745,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1645,7 +1765,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1663,7 +1785,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1681,7 +1805,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1699,7 +1825,9 @@ }, { "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" : "", @@ -1717,7 +1845,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1735,7 +1865,9 @@ }, { "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" : "", @@ -1753,7 +1885,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1771,7 +1905,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Row.json b/docs/symbols/Roo.bootstrap.Row.json index 25bc3d5e88..be144a6a61 100644 --- a/docs/symbols/Roo.bootstrap.Row.json +++ b/docs/symbols/Roo.bootstrap.Row.json @@ -23,124 +23,111 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -152,85 +139,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -242,15 +259,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -262,15 +284,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -283,43 +310,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -332,15 +374,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -359,15 +406,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -379,15 +431,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -406,15 +463,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -426,15 +488,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -446,29 +513,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -499,15 +576,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -532,15 +614,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -553,15 +640,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -574,15 +666,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -607,15 +704,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -640,15 +742,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -667,15 +774,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -700,15 +812,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -741,7 +858,9 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -759,7 +878,9 @@ }, { "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" : "", @@ -777,7 +898,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -795,7 +918,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -813,7 +938,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -831,7 +958,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -849,7 +978,9 @@ }, { "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" : "", @@ -867,7 +998,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -885,7 +1018,9 @@ }, { "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" : "", @@ -903,7 +1038,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -921,7 +1058,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.SecurePass.json b/docs/symbols/Roo.bootstrap.SecurePass.json index 1a3d74f8f9..a4f83e5692 100644 --- a/docs/symbols/Roo.bootstrap.SecurePass.json +++ b/docs/symbols/Roo.bootstrap.SecurePass.json @@ -24,525 +24,442 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "validFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "lg", "type" : "Number", "desc" : "colspan out of 12 for large computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)", "type" : "String", "desc" : "inputType", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xs", "type" : "Number", "desc" : "colspan out of 12 for mobile-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "disabled", "type" : "Boolean", "desc" : "is it disabled", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "name", "type" : "String", "desc" : "name of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "autocomplete", "type" : "String", "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "regexText", "type" : "String", "desc" : "-- Depricated - use Invalid Text", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "errors", "type" : "String/Object", "desc" : "A Error spec, or true for a default spec (defaults to\n{\n PwdEmpty: \"Please type a password, and then retype it to confirm.\",\n PwdShort: \"Your password must be at least 6 characters long. Please type a different password.\",\n PwdLong: \"Your password can't contain more than 16 characters. Please type a different password.\",\n PwdBadChar: \"The password contains characters that aren't allowed. Please type a different password.\",\n IDInPwd: \"Your password can't include the part of your ID. Please type a different password.\",\n FNInPwd: \"Your password can't contain your first name. Please type a different password.\",\n LNInPwd: \"Your password can't contain your last name. Please type a different password.\"\n})", - "memberOf" : "Roo.bootstrap.SecurePass", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "labelmd", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "value", "type" : "string", "desc" : "default value of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "Label", "type" : "String/Object", "desc" : "for the strength meter (defaults to\n'Password strength:')", - "memberOf" : "Roo.bootstrap.SecurePass", - "optvals" : [] + "memberOf" : "" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "sm", "type" : "Number", "desc" : "colspan out of 12 for tablet-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "Specifies that the field should be read-only", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "size", "type" : "string", "desc" : "- (lg|sm) or leave empty..", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labellg", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelxs", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "invalidClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "pwdStrengths", "type" : "String/Object", "desc" : "A pwdStrengths spec, or true for a default spec (defaults to\n['Weak', 'Medium', 'Strong'])", - "memberOf" : "Roo.bootstrap.SecurePass", - "optvals" : [] + "memberOf" : "" }, { "name" : "fieldLabel", "type" : "string", "desc" : "- the label associated", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "before", "type" : "string", "desc" : "- input group add on before", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "invalidFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "placeholder", "type" : "string", "desc" : "- placeholder to put in text.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "md", "type" : "Number", "desc" : "colspan out of 12 for computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", "type" : "Number", "desc" : "set the width of label", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "preventMark", "type" : "Boolean", "desc" : "Do not show tick or cross if error/success", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelsm", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "after", "type" : "string", "desc" : "- input group add on after", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" } ], "methods" : [ { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -554,15 +471,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -575,15 +497,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -595,29 +522,39 @@ }, { "name" : "markValid", + "type" : "function", "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -629,29 +566,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -663,15 +610,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -684,15 +636,20 @@ }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -705,29 +662,39 @@ }, { "name" : "inputEl", + "type" : "function", "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -746,15 +713,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -766,85 +738,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -856,15 +858,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -876,15 +883,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -897,43 +909,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -946,15 +973,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -973,15 +1005,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -993,15 +1030,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1020,15 +1062,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1040,15 +1087,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1060,29 +1112,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1113,15 +1175,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1146,15 +1213,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1167,15 +1239,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1188,15 +1265,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1221,15 +1303,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1254,15 +1341,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1281,15 +1373,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1314,15 +1411,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1355,7 +1457,9 @@ "events" : [ { "name" : "paste", + "type" : "function", "desc" : "Fires after the user pastes into input", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1379,7 +1483,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1409,7 +1515,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1433,7 +1541,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1451,7 +1561,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1469,7 +1581,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1493,7 +1607,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1511,7 +1627,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1535,7 +1653,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1553,7 +1673,9 @@ }, { "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" : "", @@ -1571,7 +1693,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1589,7 +1713,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1607,7 +1733,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1625,7 +1753,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1643,7 +1773,9 @@ }, { "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" : "", @@ -1661,7 +1793,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1679,7 +1813,9 @@ }, { "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" : "", @@ -1697,7 +1833,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1715,7 +1853,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Slider.json b/docs/symbols/Roo.bootstrap.Slider.json index 1db83a0884..4719306279 100644 --- a/docs/symbols/Roo.bootstrap.Slider.json +++ b/docs/symbols/Roo.bootstrap.Slider.json @@ -23,124 +23,111 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -152,85 +139,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -242,15 +259,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -262,15 +284,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -283,43 +310,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -332,15 +374,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -359,15 +406,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -379,15 +431,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -406,15 +463,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -426,15 +488,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -446,29 +513,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -499,15 +576,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -532,15 +614,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -553,15 +640,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -574,15 +666,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -607,15 +704,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -640,15 +742,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -667,15 +774,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -700,15 +812,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -741,7 +858,9 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -759,7 +878,9 @@ }, { "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" : "", @@ -777,7 +898,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -795,7 +918,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -813,7 +938,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -831,7 +958,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -849,7 +978,9 @@ }, { "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" : "", @@ -867,7 +998,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -885,7 +1018,9 @@ }, { "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" : "", @@ -903,7 +1038,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -921,7 +1058,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter.json b/docs/symbols/Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter.json index a67b602a3d..7e100e9324 100644 --- a/docs/symbols/Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter.json +++ b/docs/symbols/Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter.json @@ -21,19 +21,26 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "setElementSize", + "type" : "function", "desc" : "Called after drag operations to set the size of the resizing element.", + "sig" : "(s, newSize, onComplete)", + "static" : false, + "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "s", @@ -58,15 +65,20 @@ }, { "name" : "getElementSize", + "type" : "function", "desc" : "Called before drag operations to get the current size of the resizing element.", + "sig" : "(s)", + "static" : false, + "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "s", diff --git a/docs/symbols/Roo.bootstrap.SplitBar.BasicLayoutAdapter.json b/docs/symbols/Roo.bootstrap.SplitBar.BasicLayoutAdapter.json index 873f6c6d63..0784b48c55 100644 --- a/docs/symbols/Roo.bootstrap.SplitBar.BasicLayoutAdapter.json +++ b/docs/symbols/Roo.bootstrap.SplitBar.BasicLayoutAdapter.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "setElementSize", + "type" : "function", "desc" : "Called after drag operations to set the size of the resizing element.", + "sig" : "(s, newSize, onComplete)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "s", @@ -49,15 +56,20 @@ }, { "name" : "getElementSize", + "type" : "function", "desc" : "Called before drag operations to get the current size of the resizing element.", + "sig" : "(s)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "s", diff --git a/docs/symbols/Roo.bootstrap.SplitBar.json b/docs/symbols/Roo.bootstrap.SplitBar.json index 20a3565214..15ebfe7c27 100644 --- a/docs/symbols/Roo.bootstrap.SplitBar.json +++ b/docs/symbols/Roo.bootstrap.SplitBar.json @@ -14,27 +14,33 @@ "see" : "", "params" : [], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" } ], "methods" : [ { "name" : "setCurrentSize", + "type" : "function", "desc" : "Sets the initialize size for the resizing element", + "sig" : "(size)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.SplitBar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "size", @@ -47,15 +53,20 @@ }, { "name" : "setMinimumSize", + "type" : "function", "desc" : "Sets the minimum size for the resizing element", + "sig" : "(minSize)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.SplitBar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "minSize", @@ -68,15 +79,20 @@ }, { "name" : "setAdapter", + "type" : "function", "desc" : "Set the adapter this SplitBar uses", + "sig" : "(adapter)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.SplitBar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adapter", @@ -89,15 +105,20 @@ }, { "name" : "getMinimumSize", + "type" : "function", "desc" : "Gets the minimum size for the resizing element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.SplitBar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -109,15 +130,20 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Destroy this splitbar.", + "sig" : "(removeEl)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.SplitBar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "removeEl", @@ -130,15 +156,20 @@ }, { "name" : "setMaximumSize", + "type" : "function", "desc" : "Sets the maximum size for the resizing element", + "sig" : "(maxSize)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.SplitBar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "maxSize", @@ -151,15 +182,20 @@ }, { "name" : "getMaximumSize", + "type" : "function", "desc" : "Gets the maximum size for the resizing element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.SplitBar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -171,15 +207,20 @@ }, { "name" : "getAdapter", + "type" : "function", "desc" : "Get the adapter this SplitBar uses", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.SplitBar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -191,29 +232,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -244,15 +295,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -277,15 +333,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -298,15 +359,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -319,15 +385,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -352,15 +423,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -385,15 +461,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -412,15 +493,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -445,15 +531,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -486,8 +577,10 @@ "events" : [ { "name" : "beforeresize", + "type" : "function", "desc" : "Fires before the splitter is dragged", - "memberOf" : "Roo.bootstrap.SplitBar", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -504,8 +597,10 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires when the splitter is moved (alias for {@link #event-moved})", - "memberOf" : "Roo.bootstrap.SplitBar", + "sig" : "function (_self, newSize)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -528,8 +623,10 @@ }, { "name" : "moved", + "type" : "function", "desc" : "Fires when the splitter is moved", - "memberOf" : "Roo.bootstrap.SplitBar", + "sig" : "function (_self, newSize)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.bootstrap.TabGroup.json b/docs/symbols/Roo.bootstrap.TabGroup.json index cb5dc44ba4..767eea4a99 100644 --- a/docs/symbols/Roo.bootstrap.TabGroup.json +++ b/docs/symbols/Roo.bootstrap.TabGroup.json @@ -24,290 +24,231 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "xsoff", "type" : "Number", "desc" : "colspan offset out of 12 for mobile-sized screens or 0 for hidden", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Column" }, { "name" : "showarrow", "type" : "Boolean", "desc" : "e) show arrow default true", - "memberOf" : "Roo.bootstrap.TabGroup", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "lg", "type" : "Number", "desc" : "colspan out of 12 for large computer-sized screens or 0 for hidden", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Column" }, { "name" : "xs", "type" : "Number", "desc" : "colspan out of 12 for mobile-sized screens or 0 for hidden", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Column" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "navId", "type" : "String", "desc" : "the navigation id (for use with navbars) - will be auto generated if it does not exist..", - "memberOf" : "Roo.bootstrap.TabGroup", - "optvals" : [] + "memberOf" : "" }, { "name" : "bullets", "type" : "Boolean", "desc" : "show bullets for the panels", - "memberOf" : "Roo.bootstrap.TabGroup", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "timer", "type" : "Number", "desc" : "auto slide timer .. default 0 millisecond", - "memberOf" : "Roo.bootstrap.TabGroup", - "optvals" : [] + "memberOf" : "" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "autoslide", "type" : "Boolean", "desc" : "e) auto slide .. default false", - "memberOf" : "Roo.bootstrap.TabGroup", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "fasize", "type" : "Number", "desc" : ".) font awsome size", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [ - "1", - "2", - "...." - ] + "memberOf" : "Roo.bootstrap.Column" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "sm", "type" : "Number", "desc" : "colspan out of 12 for tablet-sized screens or 0 for hidden", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Column" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "carousel", "type" : "Boolean", "desc" : "true to make the group behave like a carousel", - "memberOf" : "Roo.bootstrap.TabGroup", - "optvals" : [] + "memberOf" : "" }, { "name" : "hidden", "type" : "Boolean", "desc" : "e) hide the element", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Column" }, { "name" : "fa", "type" : "String", "desc" : ".) font awesome icon", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [ - "ban", - "check", - "..." - ] + "memberOf" : "Roo.bootstrap.Column" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "icon", "type" : "String", "desc" : ".) glyphicon name", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [ - "info-sign", - "check", - "..." - ] + "memberOf" : "Roo.bootstrap.Column" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "alert", "type" : "String", "desc" : "r) type alert (changes background / border...)", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [ - "success", - "info", - "warning", - "danger" - ] + "memberOf" : "Roo.bootstrap.Column" }, { "name" : "lgoff", "type" : "Number", "desc" : "colspan offset out of 12 for large computer-sized screens or 0 for hidden", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Column" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "smoff", "type" : "Number", "desc" : "colspan offset out of 12 for tablet-sized screens or 0 for hidden", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Column" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "mdoff", "type" : "Number", "desc" : "colspan offset out of 12 for computer-sized screens or 0 for hidden", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Column" }, { "name" : "md", "type" : "Number", "desc" : "colspan out of 12 for computer-sized screens or 0 for hidden", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Column" }, { "name" : "html", "type" : "String", "desc" : "content of column.", - "memberOf" : "Roo.bootstrap.Column", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Column" } ], "methods" : [ { "name" : "register", + "type" : "function", "desc" : "register a Navigation item", + "sig" : "(the)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TabGroup", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -320,15 +261,20 @@ }, { "name" : "register", + "type" : "function", "desc" : "register a Navigation Group", + "sig" : "(the)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TabGroup", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -341,15 +287,20 @@ }, { "name" : "get", + "type" : "function", "desc" : "fetch a Navigation Group based on the navigation ID\nif one does not exist , it will get created.", + "sig" : "(the)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TabGroup", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -362,15 +313,20 @@ }, { "name" : "showPanel", + "type" : "function", "desc" : "show a specific panel", + "sig" : "(panel)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TabGroup", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -389,15 +345,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -409,85 +370,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -499,15 +490,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -519,15 +515,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -540,43 +541,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -589,15 +605,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -616,15 +637,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -636,15 +662,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -663,15 +694,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -683,15 +719,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -703,29 +744,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -756,15 +807,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -789,15 +845,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -810,15 +871,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -831,15 +897,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -864,15 +935,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -897,15 +973,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -924,15 +1005,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -957,15 +1043,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -998,7 +1089,9 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1016,7 +1109,9 @@ }, { "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" : "", @@ -1034,7 +1129,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1052,7 +1149,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1070,7 +1169,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1088,7 +1189,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1106,7 +1209,9 @@ }, { "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" : "", @@ -1124,7 +1229,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1142,7 +1249,9 @@ }, { "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" : "", @@ -1160,7 +1269,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1178,7 +1289,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.TabPanel.json b/docs/symbols/Roo.bootstrap.TabPanel.json index 9dc1ac26b6..3ce1a7f306 100644 --- a/docs/symbols/Roo.bootstrap.TabPanel.json +++ b/docs/symbols/Roo.bootstrap.TabPanel.json @@ -23,166 +23,147 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "tabId", "type" : "String", "desc" : "unique tab ID (will be autogenerated if not set. - used to match TabItem to Panel)", - "memberOf" : "Roo.bootstrap.TabPanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "navId", "type" : "String", "desc" : "The Roo.bootstrap.NavGroup which triggers show hide ()", - "memberOf" : "Roo.bootstrap.TabPanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "html", "type" : "String", "desc" : "panel content", - "memberOf" : "Roo.bootstrap.TabPanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "active", "type" : "Boolean", "desc" : "panel active", - "memberOf" : "Roo.bootstrap.TabPanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "href", "type" : "String", "desc" : "click to link..", - "memberOf" : "Roo.bootstrap.TabPanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "touchSlide", "type" : "Boolean", "desc" : "if swiping slides tab to next panel (default off)", - "memberOf" : "Roo.bootstrap.TabPanel", - "optvals" : [] + "memberOf" : "" } ], "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -194,85 +175,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -284,15 +295,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -304,15 +320,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -325,43 +346,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -374,15 +410,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -401,15 +442,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -421,15 +467,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -448,15 +499,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -468,15 +524,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -488,29 +549,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -541,15 +612,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -574,15 +650,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -595,15 +676,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -616,15 +702,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -649,15 +740,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -682,15 +778,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -709,15 +810,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -742,15 +848,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -783,8 +894,10 @@ "events" : [ { "name" : "changed", + "type" : "function", "desc" : "Fires when the active status changes", - "memberOf" : "Roo.bootstrap.TabPanel", + "sig" : "function (_self, state)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -807,8 +920,10 @@ }, { "name" : "beforedeactivate", + "type" : "function", "desc" : "Fires before a tab is de-activated - can be used to do validation on a form.", - "memberOf" : "Roo.bootstrap.TabPanel", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -831,7 +946,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -849,7 +966,9 @@ }, { "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" : "", @@ -867,7 +986,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -885,7 +1006,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -903,7 +1026,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -921,7 +1046,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -939,7 +1066,9 @@ }, { "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" : "", @@ -957,7 +1086,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -975,7 +1106,9 @@ }, { "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" : "", @@ -993,7 +1126,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1011,7 +1146,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Table.json b/docs/symbols/Roo.bootstrap.Table.json index f4a3743c48..de069415b3 100644 --- a/docs/symbols/Roo.bootstrap.Table.json +++ b/docs/symbols/Roo.bootstrap.Table.json @@ -23,275 +23,225 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "footerShow", "type" : "Boolean", "desc" : "e) generate tfoot, default true", - "memberOf" : "Roo.bootstrap.Table", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "auto_hide_footer", "type" : "Boolean", "desc" : "auto hide footer if only one page (default false)", - "memberOf" : "Roo.bootstrap.Table", - "optvals" : [] + "memberOf" : "" }, { "name" : "scrollBody", "type" : "Boolean", "desc" : "e) default false - body scrolled / fixed header", - "memberOf" : "Roo.bootstrap.Table", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "cm[]", "type" : "Roo.grid.ColumnModel", "desc" : "A column for th grid.", - "memberOf" : "Roo.bootstrap.Table", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "minColumnWidth", "type" : "Number", "desc" : "default 50 pixels minimum column width", - "memberOf" : "Roo.bootstrap.Table", - "optvals" : [] + "memberOf" : "" }, { "name" : "bordered", "type" : "boolean", "desc" : "Add borders to the table", - "memberOf" : "Roo.bootstrap.Table", - "optvals" : [] + "memberOf" : "" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "condensed", "type" : "boolean", "desc" : "Format condensed", - "memberOf" : "Roo.bootstrap.Table", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "store", - "type" : "Roo.data.Store|Roo.data.SimpleStore", + "type" : "Roo.data.Store", "desc" : "The data store to use", - "memberOf" : "Roo.bootstrap.Table", - "optvals" : [] + "memberOf" : "" }, { "name" : "cellSelection", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Table", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "sm", - "type" : "Roo.grid.RowSelectionModel|Roo.grid.CellSelectionModel", + "type" : "Roo.grid.AbstractSelectionModel", "desc" : "The selection model to use (cell selection is not supported yet)", - "memberOf" : "Roo.bootstrap.Table", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "striped", "type" : "boolean", "desc" : "Should the rows be alternative striped", - "memberOf" : "Roo.bootstrap.Table", - "optvals" : [] + "memberOf" : "" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "lazyLoad", "type" : "Boolean", "desc" : "auto load data while scrolling to the end (default false)", - "memberOf" : "Roo.bootstrap.Table", - "optvals" : [] + "memberOf" : "" }, { "name" : "footer", "type" : "Roo.bootstrap.PagingToolbar", "desc" : "a paging toolbar", - "memberOf" : "Roo.bootstrap.Table", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "table class", - "memberOf" : "Roo.bootstrap.Table", - "optvals" : [] + "memberOf" : "" }, { "name" : "headerShow", "type" : "Boolean", "desc" : "e) generate thead, default true", - "memberOf" : "Roo.bootstrap.Table", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "loadMask", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Table", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "hover", "type" : "boolean", "desc" : "Add hover highlighting", - "memberOf" : "Roo.bootstrap.Table", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "enableColumnResize", "type" : "Boolean", "desc" : "default true if columns can be resized (drag/drop)", - "memberOf" : "Roo.bootstrap.Table", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "rowSelection", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.Table", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "responsive", "type" : "boolean", "desc" : "default false - if this is on, columns are rendered with col-xs-4 etc. classes, otherwise columns will be sized by CSS,\n also adds table-responsive (see bootstrap docs for details)", - "memberOf" : "Roo.bootstrap.Table", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "setRowVisibility", + "type" : "function", "desc" : "Show or hide a row.", + "sig" : "(rowIndex, state)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Table", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "rowIndex", @@ -310,15 +260,20 @@ }, { "name" : "getRowIndex", + "type" : "function", "desc" : "get the Row Index from a dom element.", + "sig" : "(row)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Table", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "row", @@ -331,15 +286,20 @@ }, { "name" : "ensureVisible", + "type" : "function", "desc" : "Scrolls the specified cell into view", + "sig" : "(row, col, hscroll)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Table", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "row", @@ -364,15 +324,20 @@ }, { "name" : "getCellIndex", + "type" : "function", "desc" : "get the Column Index from a dom element. (using regex on x-hcol-{colid})", + "sig" : "(cell)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Table", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cell", @@ -385,15 +350,20 @@ }, { "name" : "getHeaderIndex", + "type" : "function", "desc" : "get the header TH element for columnIndex", + "sig" : "(columnIndex)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Table", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "columnIndex", @@ -406,15 +376,20 @@ }, { "name" : "focusRow", + "type" : "function", "desc" : "Focuses the specified row.", + "sig" : "(row)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Table", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "row", @@ -427,15 +402,20 @@ }, { "name" : "getGridEl", + "type" : "function", "desc" : "Returns the grid's underlying element = used by panel.Grid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Table", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -447,15 +427,20 @@ }, { "name" : "autoSize", + "type" : "function", "desc" : "Forces a resize - used by panel.Grid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Table", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -467,29 +452,39 @@ }, { "name" : "clear", + "type" : "function", "desc" : "Remove all rows", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Table", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "focusCell", + "type" : "function", "desc" : "Focuses the specified cell.", + "sig" : "(row, col, hscroll)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Table", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "row", @@ -514,15 +509,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -534,85 +534,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -624,15 +654,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -644,15 +679,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -665,43 +705,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -714,15 +769,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -741,15 +801,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -761,15 +826,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -788,15 +858,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -808,15 +883,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -828,29 +908,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -881,15 +971,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -914,15 +1009,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -935,15 +1035,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -956,15 +1061,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -989,15 +1099,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1022,15 +1137,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1049,15 +1169,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1082,15 +1207,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1123,8 +1253,10 @@ "events" : [ { "name" : "rowsrendered", + "type" : "function", "desc" : "Fires when all the rows have been rendered", - "memberOf" : "Roo.bootstrap.Table", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1141,8 +1273,10 @@ }, { "name" : "headercontextmenu", + "type" : "function", "desc" : "Fires when a header is right clicked", - "memberOf" : "Roo.bootstrap.Table", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1171,8 +1305,10 @@ }, { "name" : "rowdblclick", + "type" : "function", "desc" : "Fires when a row is double clicked", - "memberOf" : "Roo.bootstrap.Table", + "sig" : "function (_self, el, rowIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1207,8 +1343,10 @@ }, { "name" : "contextmenu", + "type" : "function", "desc" : "The raw contextmenu event for the entire grid.", - "memberOf" : "Roo.bootstrap.Table", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1225,8 +1363,10 @@ }, { "name" : "mousedown", + "type" : "function", "desc" : "The raw mousedown event for the entire grid.", - "memberOf" : "Roo.bootstrap.Table", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1243,8 +1383,10 @@ }, { "name" : "rowcontextmenu", + "type" : "function", "desc" : "Fires when a row is right clicked", - "memberOf" : "Roo.bootstrap.Table", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1273,8 +1415,10 @@ }, { "name" : "cellcontextmenu", + "type" : "function", "desc" : "Fires when a cell is right clicked", - "memberOf" : "Roo.bootstrap.Table", + "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1309,8 +1453,10 @@ }, { "name" : "celldblclick", + "type" : "function", "desc" : "Fires when a cell is double clicked", - "memberOf" : "Roo.bootstrap.Table", + "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1351,8 +1497,10 @@ }, { "name" : "rowclass", + "type" : "function", "desc" : "Fires when a row is rendered, so you can change add a style to it.", - "memberOf" : "Roo.bootstrap.Table", + "sig" : "function (_self, rowcfg)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1375,8 +1523,10 @@ }, { "name" : "mouseover", + "type" : "function", "desc" : "Fires when a mouseover occur", - "memberOf" : "Roo.bootstrap.Table", + "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1417,8 +1567,10 @@ }, { "name" : "mouseout", + "type" : "function", "desc" : "Fires when a mouseout occur", - "memberOf" : "Roo.bootstrap.Table", + "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1459,8 +1611,10 @@ }, { "name" : "cellclick", + "type" : "function", "desc" : "Fires when a cell is clicked", - "memberOf" : "Roo.bootstrap.Table", + "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1501,8 +1655,10 @@ }, { "name" : "rowclick", + "type" : "function", "desc" : "Fires when a row is clicked", - "memberOf" : "Roo.bootstrap.Table", + "sig" : "function (_self, el, rowIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1537,7 +1693,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1555,7 +1713,9 @@ }, { "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" : "", @@ -1573,7 +1733,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1591,7 +1753,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1609,7 +1773,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1627,7 +1793,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1645,7 +1813,9 @@ }, { "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" : "", @@ -1663,7 +1833,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1681,7 +1853,9 @@ }, { "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" : "", @@ -1699,7 +1873,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1717,7 +1893,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.TableBody.json b/docs/symbols/Roo.bootstrap.TableBody.json index a3ee2c4c4e..712a61375c 100644 --- a/docs/symbols/Roo.bootstrap.TableBody.json +++ b/docs/symbols/Roo.bootstrap.TableBody.json @@ -23,152 +23,135 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "charoff", "type" : "Number", "desc" : "Sets the number of characters the content inside the element will be aligned from the character specified by the char attribute", - "memberOf" : "Roo.bootstrap.TableBody", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "align", "type" : "String", "desc" : "Aligns the content inside the element", - "memberOf" : "Roo.bootstrap.TableBody", - "optvals" : [] + "memberOf" : "" }, { "name" : "valign", "type" : "String", "desc" : "Vertical aligns the content inside the element", - "memberOf" : "Roo.bootstrap.TableBody", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "tag", "type" : "String", "desc" : "element tag (thead|tbody|tfoot) default tbody", - "memberOf" : "Roo.bootstrap.TableBody", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "element class", - "memberOf" : "Roo.bootstrap.TableBody", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -180,85 +163,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -270,15 +283,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -290,15 +308,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -311,43 +334,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -360,15 +398,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -387,15 +430,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -407,15 +455,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -434,15 +487,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -454,15 +512,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -474,29 +537,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -527,15 +600,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -560,15 +638,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -581,15 +664,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -602,15 +690,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -635,15 +728,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -668,15 +766,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -695,15 +798,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -728,15 +836,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -769,7 +882,9 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -787,7 +902,9 @@ }, { "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" : "", @@ -805,7 +922,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -823,7 +942,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -841,7 +962,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -859,7 +982,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -877,7 +1002,9 @@ }, { "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" : "", @@ -895,7 +1022,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -913,7 +1042,9 @@ }, { "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" : "", @@ -931,7 +1062,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -949,7 +1082,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.TableCell.json b/docs/symbols/Roo.bootstrap.TableCell.json index 63a4147de4..0c73cd28e5 100644 --- a/docs/symbols/Roo.bootstrap.TableCell.json +++ b/docs/symbols/Roo.bootstrap.TableCell.json @@ -23,229 +23,201 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "abbr", "type" : "String", "desc" : "Specifies an abbreviated version of the content in a cell", - "memberOf" : "Roo.bootstrap.TableCell", - "optvals" : [] + "memberOf" : "" }, { "name" : "charoff", "type" : "Number", "desc" : "Sets the number of characters the content will be aligned from the character specified by the char attribute", - "memberOf" : "Roo.bootstrap.TableCell", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "axis", "type" : "String", "desc" : "Categorizes cells", - "memberOf" : "Roo.bootstrap.TableCell", - "optvals" : [] + "memberOf" : "" }, { "name" : "bgcolor", "type" : "String", "desc" : "Specifies the background color of a cell", - "memberOf" : "Roo.bootstrap.TableCell", - "optvals" : [] + "memberOf" : "" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "align", "type" : "String", "desc" : "Aligns the content in a cell", - "memberOf" : "Roo.bootstrap.TableCell", - "optvals" : [] + "memberOf" : "" }, { "name" : "valign", "type" : "String", "desc" : "Vertical aligns the content in a cell", - "memberOf" : "Roo.bootstrap.TableCell", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "tag", "type" : "String", "desc" : "cell tag (td|th) default td", - "memberOf" : "Roo.bootstrap.TableCell", - "optvals" : [] + "memberOf" : "" }, { "name" : "scope", "type" : "String", "desc" : "Defines a way to associate header cells and data cells in a table", - "memberOf" : "Roo.bootstrap.TableCell", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "html", "type" : "String", "desc" : "cell contain text", - "memberOf" : "Roo.bootstrap.TableCell", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "cell class", - "memberOf" : "Roo.bootstrap.TableCell", - "optvals" : [] + "memberOf" : "" }, { "name" : "headers", "type" : "String", "desc" : "Specifies one or more header cells a cell is related to", - "memberOf" : "Roo.bootstrap.TableCell", - "optvals" : [] + "memberOf" : "" }, { "name" : "nowrap", "type" : "String", "desc" : "Specifies that the content inside a cell should not wrap", - "memberOf" : "Roo.bootstrap.TableCell", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "width", "type" : "Number", "desc" : "Specifies the width of a cell", - "memberOf" : "Roo.bootstrap.TableCell", - "optvals" : [] + "memberOf" : "" }, { "name" : "colspan", "type" : "Number", "desc" : "Specifies the number of columns a cell should span", - "memberOf" : "Roo.bootstrap.TableCell", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "height", "type" : "Number", "desc" : "Sets the height of a cell", - "memberOf" : "Roo.bootstrap.TableCell", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "rowspan", "type" : "Number", "desc" : "Sets the number of rows a cell should span", - "memberOf" : "Roo.bootstrap.TableCell", - "optvals" : [] + "memberOf" : "" } ], "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -257,85 +229,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -347,15 +349,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -367,15 +374,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -388,43 +400,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -437,15 +464,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -464,15 +496,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -484,15 +521,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -511,15 +553,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -531,15 +578,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -551,29 +603,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -604,15 +666,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -637,15 +704,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -658,15 +730,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -679,15 +756,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -712,15 +794,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -745,15 +832,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -772,15 +864,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -805,15 +902,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -846,7 +948,9 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -864,7 +968,9 @@ }, { "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" : "", @@ -882,7 +988,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -900,7 +1008,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -918,7 +1028,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -936,7 +1048,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -954,7 +1068,9 @@ }, { "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" : "", @@ -972,7 +1088,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -990,7 +1108,9 @@ }, { "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" : "", @@ -1008,7 +1128,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1026,7 +1148,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.TableRow.json b/docs/symbols/Roo.bootstrap.TableRow.json index 62c5d43bd6..ffb2ec8c7d 100644 --- a/docs/symbols/Roo.bootstrap.TableRow.json +++ b/docs/symbols/Roo.bootstrap.TableRow.json @@ -23,152 +23,135 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "charoff", "type" : "Number", "desc" : "Sets the number of characters the content will be aligned from the character specified by the char attribute", - "memberOf" : "Roo.bootstrap.TableRow", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "bgcolor", "type" : "String", "desc" : "Specifies a background color for a table row", - "memberOf" : "Roo.bootstrap.TableRow", - "optvals" : [] + "memberOf" : "" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "align", "type" : "String", "desc" : "Aligns the content in a table row", - "memberOf" : "Roo.bootstrap.TableRow", - "optvals" : [] + "memberOf" : "" }, { "name" : "valign", "type" : "String", "desc" : "Vertical aligns the content in a table row", - "memberOf" : "Roo.bootstrap.TableRow", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "row class", - "memberOf" : "Roo.bootstrap.TableRow", - "optvals" : [] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -180,85 +163,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -270,15 +283,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -290,15 +308,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -311,43 +334,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -360,15 +398,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -387,15 +430,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -407,15 +455,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -434,15 +487,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -454,15 +512,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -474,29 +537,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -527,15 +600,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -560,15 +638,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -581,15 +664,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -602,15 +690,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -635,15 +728,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -668,15 +766,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -695,15 +798,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -728,15 +836,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -769,7 +882,9 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -787,7 +902,9 @@ }, { "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" : "", @@ -805,7 +922,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -823,7 +942,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -841,7 +962,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -859,7 +982,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -877,7 +1002,9 @@ }, { "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" : "", @@ -895,7 +1022,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -913,7 +1042,9 @@ }, { "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" : "", @@ -931,7 +1062,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -949,7 +1082,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.TextArea.json b/docs/symbols/Roo.bootstrap.TextArea.json index e050cb28fb..1b332051cf 100644 --- a/docs/symbols/Roo.bootstrap.TextArea.json +++ b/docs/symbols/Roo.bootstrap.TextArea.json @@ -24,549 +24,454 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "validFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "lg", "type" : "Number", "desc" : "colspan out of 12 for large computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)", "type" : "String", "desc" : "inputType", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xs", "type" : "Number", "desc" : "colspan out of 12 for mobile-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "disabled", "type" : "Boolean", "desc" : "is it disabled", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "name", "type" : "String", "desc" : "name of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "autocomplete", "type" : "String", "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "regexText", "type" : "String", "desc" : "-- Depricated - use Invalid Text", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "labelmd", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "value", "type" : "string", "desc" : "default value of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "sm", "type" : "Number", "desc" : "colspan out of 12 for tablet-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "Specifies that the field should be read-only", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "wrap", "type" : "string", "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a form", - "memberOf" : "Roo.bootstrap.TextArea", - "optvals" : [ - "soft", - "hard" - ] + "memberOf" : "" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "size", "type" : "string", "desc" : "- (lg|sm) or leave empty..", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labellg", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "rows", "type" : "Number", "desc" : "Specifies the visible number of lines in a text area", - "memberOf" : "Roo.bootstrap.TextArea", - "optvals" : [] + "memberOf" : "" }, { "name" : "labelxs", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "invalidClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "fieldLabel", "type" : "string", "desc" : "- the label associated", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "cols", "type" : "Number", "desc" : "Specifies the visible width of a text area", - "memberOf" : "Roo.bootstrap.TextArea", - "optvals" : [] + "memberOf" : "" }, { "name" : "before", "type" : "string", "desc" : "- input group add on before", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "invalidFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "resize", "type" : "string", "desc" : "l)", - "memberOf" : "Roo.bootstrap.TextArea", - "optvals" : [ - "none", - "both", - "horizontal", - "vertical", - "inherit", - "initial" - ] + "memberOf" : "" }, { "name" : "placeholder", "type" : "string", "desc" : "- placeholder to put in text.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "md", "type" : "Number", "desc" : "colspan out of 12 for computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", "type" : "Number", "desc" : "set the width of label", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "html", "type" : "string", "desc" : "text", - "memberOf" : "Roo.bootstrap.TextArea", - "optvals" : [] + "memberOf" : "" }, { "name" : "preventMark", "type" : "Boolean", "desc" : "Do not show tick or cross if error/success", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelsm", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "after", "type" : "string", "desc" : "- input group add on after", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" } ], "methods" : [ { "name" : "inputEl", + "type" : "function", "desc" : "return the real textarea element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TextArea", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TextArea", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -579,43 +484,58 @@ }, { "name" : "markValid", + "type" : "function", "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TextArea", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TextArea", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -627,15 +547,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -647,15 +572,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -667,29 +597,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -701,15 +641,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -722,15 +667,20 @@ }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -743,15 +693,20 @@ }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -770,15 +725,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -790,85 +750,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -880,15 +870,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -900,15 +895,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -921,43 +921,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -970,15 +985,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -997,15 +1017,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1017,15 +1042,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1044,15 +1074,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1064,15 +1099,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1084,29 +1124,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1137,15 +1187,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1170,15 +1225,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1191,15 +1251,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1212,15 +1277,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1245,15 +1315,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1278,15 +1353,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1305,15 +1385,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1338,15 +1423,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1379,7 +1469,9 @@ "events" : [ { "name" : "paste", + "type" : "function", "desc" : "Fires after the user pastes into input", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1403,7 +1495,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1433,7 +1527,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1457,7 +1553,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1475,7 +1573,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1493,7 +1593,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1517,7 +1619,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1535,7 +1639,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1559,7 +1665,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1577,7 +1685,9 @@ }, { "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" : "", @@ -1595,7 +1705,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1613,7 +1725,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1631,7 +1745,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1649,7 +1765,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1667,7 +1785,9 @@ }, { "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" : "", @@ -1685,7 +1805,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1703,7 +1825,9 @@ }, { "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" : "", @@ -1721,7 +1845,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1739,7 +1865,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.TimeField.json b/docs/symbols/Roo.bootstrap.TimeField.json index be780444d9..6cf7ea344c 100644 --- a/docs/symbols/Roo.bootstrap.TimeField.json +++ b/docs/symbols/Roo.bootstrap.TimeField.json @@ -24,511 +24,430 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "validFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "lg", "type" : "Number", "desc" : "colspan out of 12 for large computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)", "type" : "String", "desc" : "inputType", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xs", "type" : "Number", "desc" : "colspan out of 12 for mobile-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "disabled", "type" : "Boolean", "desc" : "is it disabled", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "String", "desc" : "name of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "autocomplete", "type" : "String", "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "regexText", "type" : "String", "desc" : "-- Depricated - use Invalid Text", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "labelmd", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "value", "type" : "string", "desc" : "default value of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "sm", "type" : "Number", "desc" : "colspan out of 12 for tablet-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "Specifies that the field should be read-only", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "size", "type" : "string", "desc" : "- (lg|sm) or leave empty..", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labellg", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelxs", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "fieldLabel", "type" : "string", "desc" : "- the label associated", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "before", "type" : "string", "desc" : "- input group add on before", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "invalidFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "placeholder", "type" : "string", "desc" : "- placeholder to put in text.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "format", "type" : "String", "desc" : "The default time format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'H:i').", - "memberOf" : "Roo.bootstrap.TimeField", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "md", "type" : "Number", "desc" : "colspan out of 12 for computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", "type" : "Number", "desc" : "set the width of label", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "preventMark", "type" : "Boolean", "desc" : "Do not show tick or cross if error/success", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelsm", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "after", "type" : "string", "desc" : "- input group add on after", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" } ], "methods" : [ { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -540,15 +459,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -561,15 +485,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -581,29 +510,39 @@ }, { "name" : "markValid", + "type" : "function", "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -615,29 +554,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -649,15 +598,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -670,15 +624,20 @@ }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -691,29 +650,39 @@ }, { "name" : "inputEl", + "type" : "function", "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -732,15 +701,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -752,85 +726,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -842,15 +846,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -862,15 +871,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -883,43 +897,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -932,15 +961,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -959,15 +993,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -979,15 +1018,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1006,15 +1050,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1026,15 +1075,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1046,29 +1100,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1099,15 +1163,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1132,15 +1201,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1153,15 +1227,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1174,15 +1253,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1207,15 +1291,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1240,15 +1329,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1267,15 +1361,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1300,15 +1399,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1341,8 +1445,10 @@ "events" : [ { "name" : "select", + "type" : "function", "desc" : "Fires when select a date.", - "memberOf" : "Roo.bootstrap.TimeField", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1365,8 +1471,10 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires when this field show.", - "memberOf" : "Roo.bootstrap.TimeField", + "sig" : "function (thisthis, date)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1389,7 +1497,9 @@ }, { "name" : "paste", + "type" : "function", "desc" : "Fires after the user pastes into input", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1413,7 +1523,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1443,7 +1555,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1467,7 +1581,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1485,7 +1601,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1503,7 +1621,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1527,7 +1647,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1545,7 +1667,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1569,7 +1693,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1587,7 +1713,9 @@ }, { "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" : "", @@ -1605,7 +1733,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1623,7 +1753,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1641,7 +1773,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1659,7 +1793,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1677,7 +1813,9 @@ }, { "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" : "", @@ -1695,7 +1833,9 @@ }, { "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" : "", @@ -1713,7 +1853,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1731,7 +1873,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.Tooltip.json b/docs/symbols/Roo.bootstrap.Tooltip.json index 8ba7d0d3b4..dd11c686a6 100644 --- a/docs/symbols/Roo.bootstrap.Tooltip.json +++ b/docs/symbols/Roo.bootstrap.Tooltip.json @@ -19,19 +19,26 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "currentEl", + "type" : "function", "desc" : "", + "sig" : "()\n{\n\n}", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Tooltip", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] } diff --git a/docs/symbols/Roo.bootstrap.TriggerField.json b/docs/symbols/Roo.bootstrap.TriggerField.json index 48b817dab4..491e7a6abd 100644 --- a/docs/symbols/Roo.bootstrap.TriggerField.json +++ b/docs/symbols/Roo.bootstrap.TriggerField.json @@ -24,524 +24,429 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "triggerClass", "type" : "String", "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be appended if specified.", - "memberOf" : "Roo.bootstrap.TriggerField", - "optvals" : [] + "memberOf" : "" }, { "name" : "validFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "lg", "type" : "Number", "desc" : "colspan out of 12 for large computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "accept", "type" : "String", "desc" : "o) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "image", - "video", - "audio" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)", "type" : "String", "desc" : "inputType", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xs", "type" : "Number", "desc" : "colspan out of 12 for mobile-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "disabled", "type" : "Boolean", "desc" : "is it disabled", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "String", "desc" : "name of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "autocomplete", "type" : "String", "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelAlign", "type" : "String", "desc" : "t)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "top", - "left" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "regexText", "type" : "String", "desc" : "-- Depricated - use Invalid Text", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "labelmd", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "value", "type" : "string", "desc" : "default value of the input", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hasFeedback", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "sm", "type" : "Number", "desc" : "colspan out of 12 for tablet-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "Specifies that the field should be read-only", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "indicatorpos", "type" : "String", "desc" : "t) default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "align", "type" : "String", "desc" : "t) Default left", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "left", - "center", - "right" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "size", "type" : "string", "desc" : "- (lg|sm) or leave empty..", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labellg", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "hideTrigger", "type" : "Boolean", "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", - "memberOf" : "Roo.bootstrap.TriggerField", - "optvals" : [] + "memberOf" : "" }, { "name" : "removable", "type" : "Boolean", "desc" : "e) special filter default false", - "memberOf" : "Roo.bootstrap.TriggerField", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "labelxs", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "caret", "type" : "String", "desc" : "r) BS3 only - carat fa name", - "memberOf" : "Roo.bootstrap.TriggerField", - "optvals" : [ - "search", - "calendar" - ] + "memberOf" : "" }, { "name" : "invalidClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "fieldLabel", "type" : "string", "desc" : "- the label associated", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "before", "type" : "string", "desc" : "- input group add on before", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "invalidFeedbackIcon", "type" : "String", "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "placeholder", "type" : "string", "desc" : "- placeholder to put in text.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "md", "type" : "Number", "desc" : "colspan out of 12 for computer-sized screens", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelWidth", "type" : "Number", "desc" : "set the width of label", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "capture", "type" : "String", "desc" : "a) use for file input only. (default empty)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "user", - "camera" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "validClass", "type" : "String", "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "preventMark", "type" : "Boolean", "desc" : "Do not show tick or cross if error/success", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "forceFeedback", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "labelsm", "type" : "Number", "desc" : "set the width of label (1-12)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "after", "type" : "string", "desc" : "- input group add on after", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")", - "memberOf" : "Roo.bootstrap.Input", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Input" } ], "methods" : [ { "name" : "onTriggerClick", + "type" : "function", "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "sig" : "(e)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TriggerField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -554,43 +459,58 @@ }, { "name" : "autoSize", + "type" : "function", "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.TriggerField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -602,15 +522,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -623,15 +548,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -643,29 +573,39 @@ }, { "name" : "markValid", + "type" : "function", "desc" : "Mark this field as valid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name of the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -677,29 +617,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -711,15 +661,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -732,15 +687,20 @@ }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -753,29 +713,39 @@ }, { "name" : "inputEl", + "type" : "function", "desc" : "return the real input element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.bootstrap.Input", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -794,15 +764,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -814,85 +789,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -904,15 +909,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -924,15 +934,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -945,43 +960,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -994,15 +1024,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -1021,15 +1056,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1041,15 +1081,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1068,15 +1113,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1088,15 +1138,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1108,29 +1163,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1161,15 +1226,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1194,15 +1264,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1215,15 +1290,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1236,15 +1316,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1269,15 +1354,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1302,15 +1392,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1329,15 +1424,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1362,15 +1462,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1403,7 +1508,9 @@ "events" : [ { "name" : "paste", + "type" : "function", "desc" : "Fires after the user pastes into input", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1427,7 +1534,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1457,7 +1566,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1481,7 +1592,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1499,7 +1612,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1517,7 +1632,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1541,7 +1658,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1559,7 +1678,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.bootstrap.Input", "example" : "", "deprecated" : "", @@ -1583,7 +1704,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1601,7 +1724,9 @@ }, { "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" : "", @@ -1619,7 +1744,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1637,7 +1764,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1655,7 +1784,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1673,7 +1804,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1691,7 +1824,9 @@ }, { "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" : "", @@ -1709,7 +1844,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1727,7 +1864,9 @@ }, { "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" : "", @@ -1745,7 +1884,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1763,7 +1904,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.UploadCropbox.json b/docs/symbols/Roo.bootstrap.UploadCropbox.json index b8fe1a7ad2..f0953fd0d8 100644 --- a/docs/symbols/Roo.bootstrap.UploadCropbox.json +++ b/docs/symbols/Roo.bootstrap.UploadCropbox.json @@ -23,214 +23,183 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "errorTimeout", "type" : "Number", "desc" : "default 3000", - "memberOf" : "Roo.bootstrap.UploadCropbox", - "optvals" : [] + "memberOf" : "" }, { "name" : "buttons", "type" : "Array", "desc" : "default ['rotateLeft', 'pictureBtn', 'rotateRight']", - "memberOf" : "Roo.bootstrap.UploadCropbox", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "emptyText", "type" : "String", "desc" : "show when image has been loaded", - "memberOf" : "Roo.bootstrap.UploadCropbox", - "optvals" : [] + "memberOf" : "" }, { "name" : "minWidth", "type" : "Number", "desc" : "default 300", - "memberOf" : "Roo.bootstrap.UploadCropbox", - "optvals" : [] + "memberOf" : "" }, { "name" : "method", "type" : "String", "desc" : "default POST", - "memberOf" : "Roo.bootstrap.UploadCropbox", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "paramName", "type" : "String", "desc" : "default 'imageUpload'", - "memberOf" : "Roo.bootstrap.UploadCropbox", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "minHeight", "type" : "Number", "desc" : "default 300", - "memberOf" : "Roo.bootstrap.UploadCropbox", - "optvals" : [] + "memberOf" : "" }, { "name" : "isDocument", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.UploadCropbox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "loadMask", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.UploadCropbox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "rotateNotify", "type" : "String", "desc" : "show when image too small to rotate", - "memberOf" : "Roo.bootstrap.UploadCropbox", - "optvals" : [] + "memberOf" : "" }, { "name" : "url", "type" : "String", "desc" : "action url", - "memberOf" : "Roo.bootstrap.UploadCropbox", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "loadingText", "type" : "Boolean", "desc" : "default 'Loading...'", - "memberOf" : "Roo.bootstrap.UploadCropbox", - "optvals" : [] + "memberOf" : "" } ], "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -242,85 +211,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -332,15 +331,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -352,15 +356,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -373,43 +382,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -422,15 +446,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -449,15 +478,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -469,15 +503,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -496,15 +535,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -516,15 +560,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -536,29 +585,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -589,15 +648,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -622,15 +686,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -643,15 +712,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -664,15 +738,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -697,15 +776,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -730,15 +814,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -757,15 +846,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -790,15 +884,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -831,8 +930,10 @@ "events" : [ { "name" : "arrange", + "type" : "function", "desc" : "Fire when arrange the file data", - "memberOf" : "Roo.bootstrap.UploadCropbox", + "sig" : "function (_self, formData)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -855,8 +956,10 @@ }, { "name" : "inspect", + "type" : "function", "desc" : "Fire when inspect the file", - "memberOf" : "Roo.bootstrap.UploadCropbox", + "sig" : "function (_self, file)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -879,8 +982,10 @@ }, { "name" : "crop", + "type" : "function", "desc" : "Fire after initEvent", - "memberOf" : "Roo.bootstrap.UploadCropbox", + "sig" : "function (_self, data)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -903,8 +1008,10 @@ }, { "name" : "upload", + "type" : "function", "desc" : "Fire when xhr upload the file", - "memberOf" : "Roo.bootstrap.UploadCropbox", + "sig" : "function (_self, data)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -927,8 +1034,10 @@ }, { "name" : "initial", + "type" : "function", "desc" : "Fire after initEvent", - "memberOf" : "Roo.bootstrap.UploadCropbox", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -945,8 +1054,10 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fire when resize", - "memberOf" : "Roo.bootstrap.UploadCropbox", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -963,8 +1074,10 @@ }, { "name" : "rotate", + "type" : "function", "desc" : "Fire when rotate the image", - "memberOf" : "Roo.bootstrap.UploadCropbox", + "sig" : "function (_self, pos)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -987,8 +1100,10 @@ }, { "name" : "prepare", + "type" : "function", "desc" : "Fire when preparing the file data", - "memberOf" : "Roo.bootstrap.UploadCropbox", + "sig" : "function (_self, file)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1011,8 +1126,10 @@ }, { "name" : "beforeloadcanvas", + "type" : "function", "desc" : "Fire before load the canvas", - "memberOf" : "Roo.bootstrap.UploadCropbox", + "sig" : "function (_self, src)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1035,8 +1152,10 @@ }, { "name" : "trash", + "type" : "function", "desc" : "Fire when trash image", - "memberOf" : "Roo.bootstrap.UploadCropbox", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1053,8 +1172,10 @@ }, { "name" : "beforeselectfile", + "type" : "function", "desc" : "Fire before select file", - "memberOf" : "Roo.bootstrap.UploadCropbox", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1071,8 +1192,10 @@ }, { "name" : "footerbuttonclick", + "type" : "function", "desc" : "Fire when footerbuttonclick", - "memberOf" : "Roo.bootstrap.UploadCropbox", + "sig" : "function (_self, type)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1095,8 +1218,10 @@ }, { "name" : "exception", + "type" : "function", "desc" : "Fire when get exception", - "memberOf" : "Roo.bootstrap.UploadCropbox", + "sig" : "function (_self, xhr)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1119,8 +1244,10 @@ }, { "name" : "download", + "type" : "function", "desc" : "Fire when download the image", - "memberOf" : "Roo.bootstrap.UploadCropbox", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1137,7 +1264,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1155,7 +1284,9 @@ }, { "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" : "", @@ -1173,7 +1304,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1191,7 +1324,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1209,7 +1344,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1227,7 +1364,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1245,7 +1384,9 @@ }, { "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" : "", @@ -1263,7 +1404,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1281,7 +1424,9 @@ }, { "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" : "", @@ -1299,7 +1444,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1317,7 +1464,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.breadcrumb.Item.json b/docs/symbols/Roo.bootstrap.breadcrumb.Item.json index 600302fbc6..1d78d0c2b1 100644 --- a/docs/symbols/Roo.bootstrap.breadcrumb.Item.json +++ b/docs/symbols/Roo.bootstrap.breadcrumb.Item.json @@ -23,145 +23,129 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "html", "type" : "String", "desc" : "the content of the link.", - "memberOf" : "Roo.bootstrap.breadcrumb.Item", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "active", "type" : "Boolean", "desc" : "is it active", - "memberOf" : "Roo.bootstrap.breadcrumb.Item", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "href", "type" : "String", "desc" : "where it links to if '#' is used the link will be handled by onClick.", - "memberOf" : "Roo.bootstrap.breadcrumb.Item", - "optvals" : [] + "memberOf" : "" } ], "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -173,85 +157,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -263,15 +277,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -283,15 +302,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -304,43 +328,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -353,15 +392,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -380,15 +424,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -400,15 +449,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -427,15 +481,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -447,15 +506,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -467,29 +531,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -520,15 +594,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -553,15 +632,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -574,15 +658,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -595,15 +684,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -628,15 +722,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -661,15 +760,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -688,15 +792,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -721,15 +830,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -762,8 +876,10 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "The img click event for the img.", - "memberOf" : "Roo.bootstrap.breadcrumb.Item", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -780,7 +896,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -798,7 +916,9 @@ }, { "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" : "", @@ -816,7 +936,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -834,7 +956,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -852,7 +976,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -870,7 +996,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -888,7 +1016,9 @@ }, { "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" : "", @@ -906,7 +1036,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -924,7 +1056,9 @@ }, { "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" : "", @@ -942,7 +1076,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -960,7 +1096,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.breadcrumb.Nav.json b/docs/symbols/Roo.bootstrap.breadcrumb.Nav.json index cdfc00f609..d2cc676849 100644 --- a/docs/symbols/Roo.bootstrap.breadcrumb.Nav.json +++ b/docs/symbols/Roo.bootstrap.breadcrumb.Nav.json @@ -23,124 +23,111 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -152,85 +139,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -242,15 +259,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -262,15 +284,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -283,43 +310,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -332,15 +374,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -359,15 +406,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -379,15 +431,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -406,15 +463,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -426,15 +488,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -446,29 +513,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -499,15 +576,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -532,15 +614,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -553,15 +640,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -574,15 +666,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -607,15 +704,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -640,15 +742,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -667,15 +774,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -700,15 +812,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -741,7 +858,9 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -759,7 +878,9 @@ }, { "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" : "", @@ -777,7 +898,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -795,7 +918,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -813,7 +938,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -831,7 +958,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -849,7 +978,9 @@ }, { "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" : "", @@ -867,7 +998,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -885,7 +1018,9 @@ }, { "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" : "", @@ -903,7 +1038,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -921,7 +1058,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.breadcrumb.json b/docs/symbols/Roo.bootstrap.breadcrumb.json index 83433d9ac8..9736b51f34 100644 --- a/docs/symbols/Roo.bootstrap.breadcrumb.json +++ b/docs/symbols/Roo.bootstrap.breadcrumb.json @@ -12,6 +12,8 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.bootstrap.dash.NumberBox.json b/docs/symbols/Roo.bootstrap.dash.NumberBox.json index b42f6bedfd..b924684b29 100644 --- a/docs/symbols/Roo.bootstrap.dash.NumberBox.json +++ b/docs/symbols/Roo.bootstrap.dash.NumberBox.json @@ -23,159 +23,141 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "footer", "type" : "String", "desc" : "Footer text", - "memberOf" : "Roo.bootstrap.dash.NumberBox", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "content", "type" : "String", "desc" : "Box content", - "memberOf" : "Roo.bootstrap.dash.NumberBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "can_build_overlaid", "type" : "Boolean", "desc" : "True if element can be rebuild from a HTML page", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "fhref", "type" : "String", "desc" : "Footer href", - "memberOf" : "Roo.bootstrap.dash.NumberBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "icon", "type" : "String", "desc" : "Box icon", - "memberOf" : "Roo.bootstrap.dash.NumberBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "headline", "type" : "String", "desc" : "Box headline", - "memberOf" : "Roo.bootstrap.dash.NumberBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -187,85 +169,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -277,15 +289,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -297,15 +314,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -318,43 +340,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -367,15 +404,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -394,15 +436,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -414,15 +461,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -441,15 +493,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -461,15 +518,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -481,29 +543,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -534,15 +606,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -567,15 +644,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -588,15 +670,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -609,15 +696,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -642,15 +734,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -675,15 +772,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -702,15 +804,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -735,15 +842,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -776,7 +888,9 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -794,7 +908,9 @@ }, { "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" : "", @@ -812,7 +928,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -830,7 +948,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -848,7 +968,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -866,7 +988,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -884,7 +1008,9 @@ }, { "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" : "", @@ -902,7 +1028,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -920,7 +1048,9 @@ }, { "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" : "", @@ -938,7 +1068,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -956,7 +1088,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.dash.TabBox.json b/docs/symbols/Roo.bootstrap.dash.TabBox.json index 951962032f..0aea32ce79 100644 --- a/docs/symbols/Roo.bootstrap.dash.TabBox.json +++ b/docs/symbols/Roo.bootstrap.dash.TabBox.json @@ -23,158 +23,135 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "title", "type" : "String", "desc" : "Title of the TabBox", - "memberOf" : "Roo.bootstrap.dash.TabBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "icon", "type" : "String", "desc" : "Icon of the TabBox", - "memberOf" : "Roo.bootstrap.dash.TabBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "tabScrollable", "type" : "Boolean", "desc" : "e) tab scrollable when mobile view default false", - "memberOf" : "Roo.bootstrap.dash.TabBox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "showtabs", "type" : "Boolean", "desc" : "e) show the tabs default true", - "memberOf" : "Roo.bootstrap.dash.TabBox", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" } ], "methods" : [ { "name" : "setTitle", + "type" : "function", "desc" : "Updates the box title", + "sig" : "(html)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.dash.TabBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "html", @@ -187,15 +164,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -207,85 +189,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -297,15 +309,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -317,15 +334,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -338,43 +360,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -387,15 +424,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -414,15 +456,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -434,15 +481,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -461,15 +513,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -481,15 +538,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -501,29 +563,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -554,15 +626,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -587,15 +664,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -608,15 +690,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -629,15 +716,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -662,15 +754,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -695,15 +792,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -722,15 +824,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -755,15 +862,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -796,8 +908,10 @@ "events" : [ { "name" : "activatepane", + "type" : "function", "desc" : "When a pane is activated", - "memberOf" : "Roo.bootstrap.dash.TabBox", + "sig" : "function (pane)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -814,8 +928,10 @@ }, { "name" : "addpane", + "type" : "function", "desc" : "When a pane is added", - "memberOf" : "Roo.bootstrap.dash.TabBox", + "sig" : "function (pane)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -832,7 +948,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -850,7 +968,9 @@ }, { "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" : "", @@ -868,7 +988,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -886,7 +1008,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -904,7 +1028,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -922,7 +1048,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -940,7 +1068,9 @@ }, { "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" : "", @@ -958,7 +1088,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -976,7 +1108,9 @@ }, { "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" : "", @@ -994,7 +1128,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1012,7 +1148,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.dash.TabPane.json b/docs/symbols/Roo.bootstrap.dash.TabPane.json index e35f711f7f..a4701df723 100644 --- a/docs/symbols/Roo.bootstrap.dash.TabPane.json +++ b/docs/symbols/Roo.bootstrap.dash.TabPane.json @@ -23,141 +23,123 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "title", "type" : "String", "desc" : "title of panel", - "memberOf" : "Roo.bootstrap.dash.TabPane", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "active", "type" : "Boolean", "desc" : "e) Default false", - "memberOf" : "Roo.bootstrap.dash.TabPane", - "optvals" : [ - "false", - "true" - ] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "setTitle", + "type" : "function", "desc" : "Updates the tab title", + "sig" : "(html)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.dash.TabPane", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "html", @@ -170,15 +152,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -190,85 +177,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -280,15 +297,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -300,15 +322,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -321,43 +348,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -370,15 +412,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -397,15 +444,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -417,15 +469,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -444,15 +501,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -464,15 +526,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -484,29 +551,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -537,15 +614,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -570,15 +652,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -591,15 +678,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -612,15 +704,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -645,15 +742,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -678,15 +780,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -705,15 +812,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -738,15 +850,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -779,8 +896,10 @@ "events" : [ { "name" : "activate", + "type" : "function", "desc" : "When a pane is activated", - "memberOf" : "Roo.bootstrap.dash.TabPane", + "sig" : "function (pane)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -797,7 +916,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -815,7 +936,9 @@ }, { "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" : "", @@ -833,7 +956,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -851,7 +976,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -869,7 +996,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -887,7 +1016,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -905,7 +1036,9 @@ }, { "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" : "", @@ -923,7 +1056,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -941,7 +1076,9 @@ }, { "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" : "", @@ -959,7 +1096,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -977,7 +1116,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.dash.json b/docs/symbols/Roo.bootstrap.dash.json index da4edbe9a8..dc26d4016d 100644 --- a/docs/symbols/Roo.bootstrap.dash.json +++ b/docs/symbols/Roo.bootstrap.dash.json @@ -12,6 +12,8 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.bootstrap.htmleditor.ToolbarStandard.json b/docs/symbols/Roo.bootstrap.htmleditor.ToolbarStandard.json index 4429f9eea7..860fe7d995 100644 --- a/docs/symbols/Roo.bootstrap.htmleditor.ToolbarStandard.json +++ b/docs/symbols/Roo.bootstrap.htmleditor.ToolbarStandard.json @@ -12,34 +12,39 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "btns", "type" : "Array", "desc" : "List of additional buttons.\n\n\nNEEDS Extra CSS? \n.x-html-editor-tb .x-edit-none .x-btn-text { background: none; }", - "memberOf" : "Roo.bootstrap.htmleditor.ToolbarStandard", - "optvals" : [] + "memberOf" : "" }, { "name" : "disable", "type" : "Object", "desc" : "List of elements to disable..", - "memberOf" : "Roo.bootstrap.htmleditor.ToolbarStandard", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "updateToolbar", + "type" : "function", "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.htmleditor.ToolbarStandard", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] } diff --git a/docs/symbols/Roo.bootstrap.htmleditor.json b/docs/symbols/Roo.bootstrap.htmleditor.json index de6f6b7fb8..e7b925baf7 100644 --- a/docs/symbols/Roo.bootstrap.htmleditor.json +++ b/docs/symbols/Roo.bootstrap.htmleditor.json @@ -12,6 +12,8 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.bootstrap.json b/docs/symbols/Roo.bootstrap.json index ee3c9478d6..85e076e295 100644 --- a/docs/symbols/Roo.bootstrap.json +++ b/docs/symbols/Roo.bootstrap.json @@ -12,6 +12,8 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.bootstrap.layout.Basic.json b/docs/symbols/Roo.bootstrap.layout.Basic.json index fa4583f93c..f3d6f72ea9 100644 --- a/docs/symbols/Roo.bootstrap.layout.Basic.json +++ b/docs/symbols/Roo.bootstrap.layout.Basic.json @@ -14,48 +14,51 @@ "see" : "", "params" : [], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "skipConfig", "type" : "bool", "desc" : "skip config?", - "memberOf" : "Roo.bootstrap.layout.Basic", - "optvals" : [] + "memberOf" : "" }, { "name" : "region", "type" : "string", "desc" : "the region that it inhabits..", - "memberOf" : "Roo.bootstrap.layout.Basic", - "optvals" : [] + "memberOf" : "" }, { "name" : "mgr", "type" : "Roo.bootstrap.layout.Manager", "desc" : "The manager", - "memberOf" : "Roo.bootstrap.layout.Basic", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "remove", + "type" : "function", "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.", + "sig" : "(panel, preservePanel)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Basic", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -80,15 +83,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the container element for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Basic", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -100,15 +108,20 @@ }, { "name" : "showPanel", + "type" : "function", "desc" : "Show the specified panel.", + "sig" : "(panelId)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Basic", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panelId", @@ -127,15 +140,20 @@ }, { "name" : "getPanel", + "type" : "function", "desc" : "Returns the panel specified or null if it's not in this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Basic", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -154,15 +172,20 @@ }, { "name" : "hasPanel", + "type" : "function", "desc" : "Returns true if the panel is in this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Basic", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -181,15 +204,20 @@ }, { "name" : "resizeTo", + "type" : "function", "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.", + "sig" : "(newSize)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Basic", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "newSize", @@ -202,15 +230,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Returns this regions position (north/south/east/west/center).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Basic", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -222,15 +255,20 @@ }, { "name" : "getActivePanel", + "type" : "function", "desc" : "Get the active panel for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Basic", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -242,15 +280,20 @@ }, { "name" : "isVisible", + "type" : "function", "desc" : "Returns true if this region is currently visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Basic", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -262,15 +305,20 @@ }, { "name" : "add", + "type" : "function", "desc" : "Add the passed ContentPanel(s)", + "sig" : "(panel)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Basic", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -289,29 +337,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -342,15 +400,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -375,15 +438,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -396,15 +464,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -417,15 +490,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -450,15 +528,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -483,15 +566,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -510,15 +598,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -543,15 +636,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", diff --git a/docs/symbols/Roo.bootstrap.layout.Border.json b/docs/symbols/Roo.bootstrap.layout.Border.json index 14c9a25224..3c6db70ae6 100644 --- a/docs/symbols/Roo.bootstrap.layout.Border.json +++ b/docs/symbols/Roo.bootstrap.layout.Border.json @@ -24,124 +24,111 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "add", + "type" : "function", "desc" : "Adds a ContentPanel (or subclass) to this layout.", + "sig" : "(target, panel)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Border", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -166,15 +153,20 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Remove a ContentPanel (or subclass) to this layout.", + "sig" : "(target, panel)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Border", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -199,15 +191,20 @@ }, { "name" : "addxtype", + "type" : "function", "desc" : "Adds a xtype elements to the layout.\n
\n\nlayout.addxtype({\n       xtype : 'ContentPanel',\n       region: 'west',\n       items: [ .... ]\n   }\n);\n\nlayout.addxtype({\n        xtype : 'NestedLayoutPanel',\n        region: 'west',\n        layout: {\n           center: { },\n           west: { }   \n        },\n        items : [ ... list of content panels or nested layout panels.. ]\n   }\n);\n
", + "sig" : "(cfg)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Border", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cfg", @@ -220,15 +217,20 @@ }, { "name" : "addRegion", + "type" : "function", "desc" : "Creates and adds a new region if it doesn't already exist.", + "sig" : "(target, config)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Border", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -253,15 +255,20 @@ }, { "name" : "showPanel", + "type" : "function", "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.", + "sig" : "(panelId)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Border", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panelId", @@ -280,15 +287,20 @@ }, { "name" : "findPanel", + "type" : "function", "desc" : "Searches all regions for a panel with the specified id", + "sig" : "(panelId)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Border", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panelId", @@ -307,29 +319,39 @@ }, { "name" : "layout", + "type" : "function", "desc" : "Performs a layout update.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Border", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getViewSize", + "type" : "function", "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.layout.Manager", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Manager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -341,15 +363,20 @@ }, { "name" : "isUpdating", + "type" : "function", "desc" : "Returns true if this layout is currently being updated", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.layout.Manager", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Manager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -361,15 +388,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the Element this layout is bound to.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.layout.Manager", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Manager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -381,15 +413,20 @@ }, { "name" : "endUpdate", + "type" : "function", "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout", + "sig" : "(noLayout)", + "static" : false, + "memberOf" : "Roo.bootstrap.layout.Manager", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Manager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "noLayout", @@ -402,29 +439,39 @@ }, { "name" : "beginUpdate", + "type" : "function", "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.layout.Manager", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Manager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getRegion", + "type" : "function", "desc" : "Returns the specified region.", + "sig" : "(target)", + "static" : false, + "memberOf" : "Roo.bootstrap.layout.Manager", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Manager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -443,15 +490,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -463,85 +515,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -553,15 +635,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -573,15 +660,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -594,43 +686,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -643,15 +750,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -670,15 +782,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -690,15 +807,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -717,15 +839,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -737,29 +864,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -790,15 +927,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -823,15 +965,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -844,15 +991,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -865,15 +1017,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -898,15 +1055,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -931,15 +1093,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -958,15 +1125,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -991,15 +1163,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1032,7 +1209,9 @@ "events" : [ { "name" : "regioncollapsed", + "type" : "function", "desc" : "Fires when a region is collapsed.", + "sig" : "function (region)\n{\n\n}", "memberOf" : "Roo.bootstrap.layout.Manager", "example" : "", "deprecated" : "", @@ -1050,7 +1229,9 @@ }, { "name" : "regionexpanded", + "type" : "function", "desc" : "Fires when a region is expanded.", + "sig" : "function (region)\n{\n\n}", "memberOf" : "Roo.bootstrap.layout.Manager", "example" : "", "deprecated" : "", @@ -1068,7 +1249,9 @@ }, { "name" : "layout", + "type" : "function", "desc" : "Fires when a layout is performed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.layout.Manager", "example" : "", "deprecated" : "", @@ -1086,7 +1269,9 @@ }, { "name" : "regionresized", + "type" : "function", "desc" : "Fires when the user resizes a region.", + "sig" : "function (region, newSize)\n{\n\n}", "memberOf" : "Roo.bootstrap.layout.Manager", "example" : "", "deprecated" : "", @@ -1110,7 +1295,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -1128,7 +1315,9 @@ }, { "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" : "", @@ -1146,7 +1335,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1164,7 +1355,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1182,7 +1375,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1200,7 +1395,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1218,7 +1415,9 @@ }, { "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" : "", @@ -1236,7 +1435,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1254,7 +1455,9 @@ }, { "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" : "", @@ -1272,7 +1475,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1290,7 +1495,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.layout.Manager.json b/docs/symbols/Roo.bootstrap.layout.Manager.json index 03f35812f3..6d904d9871 100644 --- a/docs/symbols/Roo.bootstrap.layout.Manager.json +++ b/docs/symbols/Roo.bootstrap.layout.Manager.json @@ -16,124 +16,111 @@ "see" : "", "params" : [], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "getViewSize", + "type" : "function", "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Manager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -145,15 +132,20 @@ }, { "name" : "isUpdating", + "type" : "function", "desc" : "Returns true if this layout is currently being updated", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Manager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -165,15 +157,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the Element this layout is bound to.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Manager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -185,15 +182,20 @@ }, { "name" : "endUpdate", + "type" : "function", "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout", + "sig" : "(noLayout)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Manager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "noLayout", @@ -206,29 +208,39 @@ }, { "name" : "beginUpdate", + "type" : "function", "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Manager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getRegion", + "type" : "function", "desc" : "Returns the specified region.", + "sig" : "(target)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Manager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -247,15 +259,20 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -267,85 +284,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -357,15 +404,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -377,15 +429,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -398,43 +455,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -447,15 +519,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -474,15 +551,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -494,15 +576,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -521,15 +608,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -541,29 +633,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -594,15 +696,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -627,15 +734,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -648,15 +760,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -669,15 +786,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -702,15 +824,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -735,15 +862,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -762,15 +894,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -795,15 +932,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -836,8 +978,10 @@ "events" : [ { "name" : "regioncollapsed", + "type" : "function", "desc" : "Fires when a region is collapsed.", - "memberOf" : "Roo.bootstrap.layout.Manager", + "sig" : "function (region)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -854,8 +998,10 @@ }, { "name" : "regionexpanded", + "type" : "function", "desc" : "Fires when a region is expanded.", - "memberOf" : "Roo.bootstrap.layout.Manager", + "sig" : "function (region)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -872,8 +1018,10 @@ }, { "name" : "layout", + "type" : "function", "desc" : "Fires when a layout is performed.", - "memberOf" : "Roo.bootstrap.layout.Manager", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -890,8 +1038,10 @@ }, { "name" : "regionresized", + "type" : "function", "desc" : "Fires when the user resizes a region.", - "memberOf" : "Roo.bootstrap.layout.Manager", + "sig" : "function (region, newSize)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -914,7 +1064,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -932,7 +1084,9 @@ }, { "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" : "", @@ -950,7 +1104,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -968,7 +1124,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -986,7 +1144,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1004,7 +1164,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1022,7 +1184,9 @@ }, { "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" : "", @@ -1040,7 +1204,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1058,7 +1224,9 @@ }, { "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" : "", @@ -1076,7 +1244,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1094,7 +1264,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.layout.Region.json b/docs/symbols/Roo.bootstrap.layout.Region.json index 544e9248b7..802d3a7793 100644 --- a/docs/symbols/Roo.bootstrap.layout.Region.json +++ b/docs/symbols/Roo.bootstrap.layout.Region.json @@ -15,222 +15,195 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "cmargins", "type" : "Object", "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" }, { "name" : "alwaysShowTabs", "type" : "Boolean", "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" }, { "name" : "overflow", "type" : "String", "desc" : "e) if you have menus in the region, then you need to set this to visible.", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [ - "hidden", - "visible" - ] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "margins", "type" : "Object", "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" }, { "name" : "preferredTabWidth", "type" : "Number", "desc" : "The preferred tab width (defaults to 150)", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" }, { "name" : "disableTabTips", "type" : "Boolean", "desc" : "True to disable tab tooltips", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" }, { "name" : "skipConfig", "type" : "bool", "desc" : "skip config?", - "memberOf" : "Roo.bootstrap.layout.Basic", - "optvals" : [] + "memberOf" : "Roo.bootstrap.layout.Basic" }, { "name" : "autoScroll", "type" : "Boolean", "desc" : "True to enable overflow scrolling (defaults to false)", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" }, { "name" : "hidden", "type" : "Boolean", "desc" : "True to start the region hidden (defaults to false)", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" }, { "name" : "toolbar", "type" : "Boolean", "desc" : "xtype configuration for a toolbar - shows on right of tabbar", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" }, { "name" : "region", "type" : "string", "desc" : "the region that it inhabits..", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" }, { "name" : "title", "type" : "String", "desc" : "The title for the region (overrides panel titles)", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" }, { "name" : "hideWhenEmpty", "type" : "Boolean", "desc" : "True to hide the region when it has no panels", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" }, { "name" : "mgr", "type" : "Roo.bootstrap.layout.Manager", "desc" : "The manager", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "string", "desc" : "Extra CSS classes to add to region", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" }, { "name" : "hideTabs", "type" : "Boolean", "desc" : "True to hide the tab strip (defaults to false)", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" }, { "name" : "resizeTabs", "type" : "Boolean", "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" }, { "name" : "tabPosition", "type" : "String", "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [ - "top", - "bottom" - ] + "memberOf" : "" }, { "name" : "width", "type" : "Number", "desc" : "For East/West panels", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" }, { "name" : "minTabWidth", "type" : "Number", "desc" : "The minimum tab width (defaults to 40)", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" }, { "name" : "split", "type" : "Boolean", "desc" : "To show the splitter", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" }, { "name" : "titlebar", "type" : "Boolean", "desc" : "True to display a title bar (defaults to true)", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" }, { "name" : "preservePanels", "type" : "Boolean", "desc" : "True to preserve removed panels so they can be readded later (defaults to false)", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" }, { "name" : "closeOnTab", "type" : "Boolean", "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" }, { "name" : "height", "type" : "Number", "desc" : "For North/South panels", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" }, { "name" : "animate", "type" : "Boolean", "desc" : "True to animate expand/collapse (defaults to false)", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" }, { "name" : "autoHide", "type" : "Boolean", "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)", - "memberOf" : "Roo.bootstrap.layout.Region", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "unhidePanel", + "type" : "function", "desc" : "Unhides the tab for a previously hidden panel.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Region", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -243,15 +216,20 @@ }, { "name" : "showPanel", + "type" : "function", "desc" : "Shows the specified panel.", + "sig" : "(panelId)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Region", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panelId", @@ -270,15 +248,20 @@ }, { "name" : "add", + "type" : "function", "desc" : "Adds the passed ContentPanel(s) to this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Region", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -297,15 +280,20 @@ }, { "name" : "animateCollapse", + "type" : "function", "desc" : "Collapses this region.", + "sig" : "(skipAnim)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Region", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "skipAnim", @@ -318,15 +306,20 @@ }, { "name" : "animateExpand", + "type" : "function", "desc" : "Expands this region if it was previously collapsed.", + "sig" : "(e, skipAnim)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Region", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -345,15 +338,20 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.", + "sig" : "(panel, preservePanel)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Region", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -378,43 +376,58 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hides this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Region", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "show", + "type" : "function", "desc" : "Shows this region if it was previously hidden.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Region", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getBox", + "type" : "function", "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)", + "sig" : "(title)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Region", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "title", @@ -427,15 +440,20 @@ }, { "name" : "hidePanel", + "type" : "function", "desc" : "Hides the tab for the specified panel.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Region", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -448,15 +466,20 @@ }, { "name" : "getActivePanel", + "type" : "function", "desc" : "Get the active panel for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Region", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -468,15 +491,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the container element for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Region", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -488,15 +516,20 @@ }, { "name" : "getTabs", + "type" : "function", "desc" : "Returns the TabPanel component used by this region", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Region", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -508,15 +541,20 @@ }, { "name" : "isVisible", + "type" : "function", "desc" : "Returns true if this region is currently visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Region", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -528,15 +566,20 @@ }, { "name" : "getPanel", + "type" : "function", "desc" : "Returns the panel specified or null if it's not in this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.bootstrap.layout.Basic", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Basic", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -555,15 +598,20 @@ }, { "name" : "hasPanel", + "type" : "function", "desc" : "Returns true if the panel is in this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.bootstrap.layout.Basic", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Basic", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -582,15 +630,20 @@ }, { "name" : "resizeTo", + "type" : "function", "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.", + "sig" : "(newSize)", + "static" : false, + "memberOf" : "Roo.bootstrap.layout.Basic", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Basic", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "newSize", @@ -603,15 +656,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Returns this regions position (north/south/east/west/center).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.layout.Basic", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Basic", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -623,29 +681,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -676,15 +744,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -709,15 +782,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -730,15 +808,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -751,15 +834,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -784,15 +872,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -817,15 +910,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -844,15 +942,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -877,15 +980,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", diff --git a/docs/symbols/Roo.bootstrap.layout.Split.json b/docs/symbols/Roo.bootstrap.layout.Split.json index 96ee13dc61..6d2e71915e 100644 --- a/docs/symbols/Roo.bootstrap.layout.Split.json +++ b/docs/symbols/Roo.bootstrap.layout.Split.json @@ -16,219 +16,195 @@ "see" : "", "params" : [], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "cmargins", "type" : "Object", "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "alwaysShowTabs", "type" : "Boolean", "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "margins", "type" : "Object", "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "preferredTabWidth", "type" : "Number", "desc" : "The preferred tab width (defaults to 150)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "disableTabTips", "type" : "Boolean", "desc" : "True to disable tab tooltips", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "collapsible", "type" : "Boolean", "desc" : "False to disable collapsing (defaults to true)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "collapsedTitle", "type" : "String", "desc" : "Optional string message to display in the collapsed block of a north or south region", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "autoScroll", "type" : "Boolean", "desc" : "True to enable overflow scrolling (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "hidden", "type" : "Boolean", "desc" : "True to start the region hidden (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "toolbar", "type" : "Boolean", "desc" : "xtype configuration for a toolbar - shows on right of tabbar", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "title", "type" : "String", "desc" : "The title for the region (overrides panel titles)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "hideWhenEmpty", "type" : "Boolean", "desc" : "True to hide the region when it has no panels", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "collapsed", "type" : "Boolean", "desc" : "True to set the initial display to collapsed (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "hideTabs", "type" : "Boolean", "desc" : "True to hide the tab strip (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "resizeTabs", "type" : "Boolean", "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "tabPosition", "type" : "String", "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [ - "top", - "bottom" - ] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "width", "type" : "Number", "desc" : "For East/West panels", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "floatable", "type" : "Boolean", "desc" : "False to disable floating (defaults to true)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "minTabWidth", "type" : "Number", "desc" : "The minimum tab width (defaults to 40)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "split", "type" : "Boolean", "desc" : "To show the splitter", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "titlebar", "type" : "Boolean", "desc" : "True to display a title bar (defaults to true)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "preservePanels", "type" : "Boolean", "desc" : "True to preserve removed panels so they can be readded later (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "closeOnTab", "type" : "Boolean", "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "height", "type" : "Number", "desc" : "For North/South panels", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "animate", "type" : "Boolean", "desc" : "True to animate expand/collapse (defaults to false)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "autoHide", "type" : "Boolean", "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" }, { "name" : "showPin", "type" : "Boolean", "desc" : "True to show a pin button", - "memberOf" : "Roo.LayoutRegion", - "optvals" : [] + "memberOf" : "Roo.LayoutRegion" } ], "methods" : [ { "name" : "getSplitBar", + "type" : "function", "desc" : "Returns the {@link Roo.SplitBar} for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.layout.Split", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -240,15 +216,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the container element for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -260,15 +241,20 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.", + "sig" : "(panel, preservePanel)", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -293,15 +279,20 @@ }, { "name" : "getActivePanel", + "type" : "function", "desc" : "Get the active panel for this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -313,15 +304,20 @@ }, { "name" : "collapse", + "type" : "function", "desc" : "Collapses this region.", + "sig" : "(skipAnim)", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "skipAnim", @@ -334,15 +330,20 @@ }, { "name" : "unhidePanel", + "type" : "function", "desc" : "Unhides the tab for a previously hidden panel.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -355,15 +356,20 @@ }, { "name" : "setCollapsedTitle", + "type" : "function", "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)", + "sig" : "(title)", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "title", @@ -376,15 +382,20 @@ }, { "name" : "getTabs", + "type" : "function", "desc" : "Returns the TabPanel component used by this region", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -396,15 +407,20 @@ }, { "name" : "expand", + "type" : "function", "desc" : "Expands this region if it was previously collapsed.", + "sig" : "(e, skipAnim)", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -423,15 +439,20 @@ }, { "name" : "isVisible", + "type" : "function", "desc" : "Returns true if this region is currently visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -443,15 +464,20 @@ }, { "name" : "showPanel", + "type" : "function", "desc" : "Shows the specified panel.", + "sig" : "(panelId)", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panelId", @@ -470,43 +496,58 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hides this region.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "show", + "type" : "function", "desc" : "Shows this region if it was previously hidden.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "add", + "type" : "function", "desc" : "Adds the passed ContentPanel(s) to this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -525,15 +566,20 @@ }, { "name" : "hidePanel", + "type" : "function", "desc" : "Hides the tab for the specified panel.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.LayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.LayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -546,15 +592,20 @@ }, { "name" : "hasPanel", + "type" : "function", "desc" : "Returns true if the panel is in this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.BasicLayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -573,15 +624,20 @@ }, { "name" : "resizeTo", + "type" : "function", "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.", + "sig" : "(newSize)", + "static" : false, + "memberOf" : "Roo.BasicLayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "newSize", @@ -594,15 +650,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Returns this regions position (north/south/east/west/center).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BasicLayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -614,15 +675,20 @@ }, { "name" : "getPanel", + "type" : "function", "desc" : "Returns the panel specified or null if it's not in this region.", + "sig" : "(panel)", + "static" : false, + "memberOf" : "Roo.BasicLayoutRegion", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "panel", @@ -641,29 +707,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -694,15 +770,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -727,15 +808,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -748,15 +834,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -769,15 +860,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -802,15 +898,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -835,15 +936,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -862,15 +968,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -895,15 +1006,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -936,7 +1052,9 @@ "events" : [ { "name" : "paneladded", + "type" : "function", "desc" : "Fires when a panel is added.", + "sig" : "function (_self, panel)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -960,7 +1078,9 @@ }, { "name" : "invalidated", + "type" : "function", "desc" : "Fires when the layout for this region is changed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -978,7 +1098,9 @@ }, { "name" : "expanded", + "type" : "function", "desc" : "Fires when this region is expanded.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -996,7 +1118,9 @@ }, { "name" : "beforeremove", + "type" : "function", "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.", + "sig" : "function (_self, panel, e)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1026,7 +1150,9 @@ }, { "name" : "collapsed", + "type" : "function", "desc" : "Fires when this region is collapsed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1044,7 +1170,9 @@ }, { "name" : "panelremoved", + "type" : "function", "desc" : "Fires when a panel is removed.", + "sig" : "function (_self, panel)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1068,7 +1196,9 @@ }, { "name" : "beforecollapse", + "type" : "function", "desc" : "Fires when this region before collapse.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1086,7 +1216,9 @@ }, { "name" : "slidehide", + "type" : "function", "desc" : "Fires when this region slides out of view.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1104,7 +1236,9 @@ }, { "name" : "visibilitychange", + "type" : "function", "desc" : "Fires when this region is shown or hidden", + "sig" : "function (_self, visibility)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1128,7 +1262,9 @@ }, { "name" : "slideshow", + "type" : "function", "desc" : "Fires when this region is slid into view.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1146,7 +1282,9 @@ }, { "name" : "panelactivated", + "type" : "function", "desc" : "Fires when a panel is activated.", + "sig" : "function (_self, panel)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", @@ -1170,7 +1308,9 @@ }, { "name" : "resized", + "type" : "function", "desc" : "Fires when the user resizes this region.", + "sig" : "function (_self, newSize)\n{\n\n}", "memberOf" : "Roo.BasicLayoutRegion", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.bootstrap.layout.json b/docs/symbols/Roo.bootstrap.layout.json index 375d19add9..719c1534bc 100644 --- a/docs/symbols/Roo.bootstrap.layout.json +++ b/docs/symbols/Roo.bootstrap.layout.json @@ -12,6 +12,8 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.bootstrap.menu.Item.json b/docs/symbols/Roo.bootstrap.menu.Item.json index 3a39b92793..13474f2838 100644 --- a/docs/symbols/Roo.bootstrap.menu.Item.json +++ b/docs/symbols/Roo.bootstrap.menu.Item.json @@ -23,182 +23,153 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "html", "type" : "String", "desc" : "text of the item", - "memberOf" : "Roo.bootstrap.menu.Item", - "optvals" : [] + "memberOf" : "" }, { "name" : "preventDefault", "type" : "Boolean", "desc" : "e) default true", - "memberOf" : "Roo.bootstrap.menu.Item", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "pos", "type" : "String", "desc" : "Submenu align to (left | right) default right", - "memberOf" : "Roo.bootstrap.menu.Item", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "submenu", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.menu.Item", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "disable", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.bootstrap.menu.Item", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "xattr", "type" : "Object", "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "icon", "type" : "String", "desc" : "Font awesome icon", - "memberOf" : "Roo.bootstrap.menu.Item", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "href", "type" : "String", "desc" : "the link", - "memberOf" : "Roo.bootstrap.menu.Item", - "optvals" : [] + "memberOf" : "" } ], "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -210,85 +181,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -300,15 +301,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -320,15 +326,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -341,43 +352,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -390,15 +416,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -417,15 +448,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -437,15 +473,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -464,15 +505,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -484,15 +530,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -504,29 +555,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -557,15 +618,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -590,15 +656,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -611,15 +682,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -632,15 +708,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -665,15 +746,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -698,15 +784,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -725,15 +816,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -758,15 +854,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -799,8 +900,10 @@ "events" : [ { "name" : "mouseover", + "type" : "function", "desc" : "Fires when the mouse is hovering over this menu", - "memberOf" : "Roo.bootstrap.menu.Item", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -823,8 +926,10 @@ }, { "name" : "mouseout", + "type" : "function", "desc" : "Fires when the mouse exits this menu", - "memberOf" : "Roo.bootstrap.menu.Item", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -847,8 +952,10 @@ }, { "name" : "click", + "type" : "function", "desc" : "The raw click event for the entire grid.", - "memberOf" : "Roo.bootstrap.menu.Item", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -865,7 +972,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -883,7 +992,9 @@ }, { "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" : "", @@ -901,7 +1012,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -919,7 +1032,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -937,7 +1052,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -955,7 +1072,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -973,7 +1092,9 @@ }, { "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" : "", @@ -991,7 +1112,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1009,7 +1132,9 @@ }, { "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" : "", @@ -1027,7 +1152,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1045,7 +1172,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.menu.Menu.json b/docs/symbols/Roo.bootstrap.menu.Menu.json index 564ac642b9..6ed529cb02 100644 --- a/docs/symbols/Roo.bootstrap.menu.Menu.json +++ b/docs/symbols/Roo.bootstrap.menu.Menu.json @@ -23,160 +23,135 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "html", "type" : "String", "desc" : "Text of the menu", - "memberOf" : "Roo.bootstrap.menu.Menu", - "optvals" : [] + "memberOf" : "" }, { "name" : "pos", "type" : "String", "desc" : "Menu align to (top | bottom) default bottom", - "memberOf" : "Roo.bootstrap.menu.Menu", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "icon", "type" : "String", "desc" : "Font awesome icon", - "memberOf" : "Roo.bootstrap.menu.Menu", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "weight", "type" : "String", "desc" : "e)", - "memberOf" : "Roo.bootstrap.menu.Menu", - "optvals" : [ - "default", - "primary", - "success", - "info", - "warning", - "danger", - "inverse" - ] + "memberOf" : "" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -188,85 +163,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -278,15 +283,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -298,15 +308,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -319,43 +334,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -368,15 +398,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -395,15 +430,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -415,15 +455,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -442,15 +487,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -462,15 +512,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -482,29 +537,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -535,15 +600,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -568,15 +638,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -589,15 +664,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -610,15 +690,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -643,15 +728,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -676,15 +766,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -703,15 +798,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -736,15 +836,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -777,8 +882,10 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)", - "memberOf" : "Roo.bootstrap.menu.Menu", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -801,8 +908,10 @@ }, { "name" : "beforehide", + "type" : "function", "desc" : "Fires before this menu is hidden", - "memberOf" : "Roo.bootstrap.menu.Menu", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -819,8 +928,10 @@ }, { "name" : "beforeshow", + "type" : "function", "desc" : "Fires before this menu is displayed", - "memberOf" : "Roo.bootstrap.menu.Menu", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -837,8 +948,10 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after this menu is hidden", - "memberOf" : "Roo.bootstrap.menu.Menu", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -855,8 +968,10 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after this menu is displayed", - "memberOf" : "Roo.bootstrap.menu.Menu", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -873,7 +988,9 @@ }, { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -891,7 +1008,9 @@ }, { "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" : "", @@ -909,7 +1028,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -927,7 +1048,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -945,7 +1068,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -963,7 +1088,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -981,7 +1108,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.menu.Separator.json b/docs/symbols/Roo.bootstrap.menu.Separator.json index 339b5d1006..8ebd468735 100644 --- a/docs/symbols/Roo.bootstrap.menu.Separator.json +++ b/docs/symbols/Roo.bootstrap.menu.Separator.json @@ -23,124 +23,111 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "container_method", "type" : "string", "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "tooltip", "type" : "string", "desc" : "Text for the tooltip", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "visibilityEl", "type" : "string|object", "desc" : "t) What element to use for visibility (@see getVisibilityEl())", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [ - "el", - "parent" - ] + "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", - "optvals" : [] + "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String", "desc" : "any extra css", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "css class", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "dataId", "type" : "string", "desc" : "cutomer id", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "memberOf" : "Roo.bootstrap.Component" }, { "name" : "name", "type" : "string", "desc" : "Specifies name attribute", - "memberOf" : "Roo.bootstrap.Component", - "optvals" : [] + "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", - "optvals" : [] + "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -152,85 +139,115 @@ }, { "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "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, - "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -242,15 +259,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -262,15 +284,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -283,43 +310,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -332,15 +374,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -359,15 +406,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -379,15 +431,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -406,15 +463,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -426,15 +488,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -446,29 +513,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -499,15 +576,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -532,15 +614,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -553,15 +640,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -574,15 +666,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -607,15 +704,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -640,15 +742,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -667,15 +774,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -700,15 +812,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -741,7 +858,9 @@ "events" : [ { "name" : "childrenrendered", + "type" : "function", "desc" : "Fires when the children have been rendered..", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.Component", "example" : "", "deprecated" : "", @@ -759,7 +878,9 @@ }, { "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" : "", @@ -777,7 +898,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -795,7 +918,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -813,7 +938,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -831,7 +958,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -849,7 +978,9 @@ }, { "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" : "", @@ -867,7 +998,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -885,7 +1018,9 @@ }, { "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" : "", @@ -903,7 +1038,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -921,7 +1058,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.bootstrap.menu.json b/docs/symbols/Roo.bootstrap.menu.json index e5fac32a75..4dd50c5638 100644 --- a/docs/symbols/Roo.bootstrap.menu.json +++ b/docs/symbols/Roo.bootstrap.menu.json @@ -12,6 +12,8 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.bootstrap.panel.Content.json b/docs/symbols/Roo.bootstrap.panel.Content.json index 36c0b78763..42195a0536 100644 --- a/docs/symbols/Roo.bootstrap.panel.Content.json +++ b/docs/symbols/Roo.bootstrap.panel.Content.json @@ -3,7 +3,7 @@ "augments" : [ "Roo.util.Observable" ], - "desc" : "A basic ContentPanel element.", + "desc" : "A basic ContentPanel element. - a panel that contain any content (eg. forms etc.)", "isSingleton" : false, "isStatic" : false, "isBuiltin" : false, @@ -39,173 +39,160 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "loadOnce", "type" : "Boolean", "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "badges", "type" : "Boolean", "desc" : "render the badges", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "" }, { "name" : "autoScroll", "type" : "Boolean", "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "" }, { "name" : "fitToFrame", "type" : "Boolean", "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "" }, { "name" : "background", "type" : "Boolean", "desc" : "True if the panel should not be activated when it is added (defaults to false)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "" }, { "name" : "toolbar", "type" : "Toolbar", "desc" : "A toolbar for this panel", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "" }, { "name" : "region", "type" : "String", "desc" : "t) which region to put this panel on (when used with xtype constructors)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [ - "center", - "north", - "south", - "east", - "west" - ] + "memberOf" : "" }, { "name" : "content", "type" : "String", "desc" : "Raw content to fill content panel with (uses setContent on construction.)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "" }, { "name" : "title", "type" : "String", "desc" : "The title for this panel", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "" }, { "name" : "iframe", "type" : "Boolean", "desc" : "contents are an iframe - makes showing remote sources/CSS feasible..", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "extra classes to use", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "" }, { "name" : "autoCreate", "type" : "Boolean/Object", "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "" }, { "name" : "fitContainer", "type" : "Boolean", "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "" }, { "name" : "closable", "type" : "Boolean", "desc" : "True if the panel can be closed/removed", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "" }, { "name" : "params", "type" : "String/Object", "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "" }, { "name" : "adjustments", "type" : "Array", "desc" : "Values to add to the width/height when doing a {@link #fitToFrame} (default is [0, 0])", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "" }, { "name" : "url", "type" : "String", "desc" : "Calls {@link #setUrl} with this value", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "" }, { "name" : "resizeEl", "type" : "String/HTMLElement/Element", "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "refresh", + "type" : "function", "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getUpdateManager", + "type" : "function", "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -217,15 +204,20 @@ }, { "name" : "getChildContainer", + "type" : "function", "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n
\n\nlayout.addxtype({\n       xtype : 'Form',\n       items: [ .... ]\n   }\n);\n\n
", + "sig" : "(cfg)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cfg", @@ -238,15 +230,20 @@ }, { "name" : "getToolbar", + "type" : "function", "desc" : "Returns the toolbar for this Panel if one was configured.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -258,15 +255,20 @@ }, { "name" : "setTitle", + "type" : "function", "desc" : "Set this panel's title", + "sig" : "(title)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "title", @@ -279,15 +281,20 @@ }, { "name" : "setUrl", + "type" : "function", "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.", + "sig" : "(url, params, loadOnce)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "url", @@ -318,15 +325,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns this panel's element - used by regiosn to add.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -338,29 +350,39 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Destroys this panel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "load", + "type" : "function", "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents", + "sig" : "(url, params, callback, discardUrl)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "url", @@ -397,15 +419,20 @@ }, { "name" : "getTitle", + "type" : "function", "desc" : "Returns this panel's title", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -417,15 +444,20 @@ }, { "name" : "isClosable", + "type" : "function", "desc" : "Returns true is this panel was configured to be closable", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -437,15 +469,20 @@ }, { "name" : "getId", + "type" : "function", "desc" : "Returns this panel's id", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -457,15 +494,20 @@ }, { "name" : "setContent", + "type" : "function", "desc" : "Updates this panel's element (not for iframe)", + "sig" : "(content, loadScripts)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "content", @@ -484,29 +526,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -537,15 +589,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -570,15 +627,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -591,15 +653,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -612,15 +679,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -645,15 +717,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -678,15 +755,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -705,15 +787,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -738,15 +825,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -779,8 +871,10 @@ "events" : [ { "name" : "activate", + "type" : "function", "desc" : "Fires when this panel is activated.", - "memberOf" : "Roo.bootstrap.panel.Content", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -797,8 +891,10 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires when this panel is resized if fitToFrame is true.", - "memberOf" : "Roo.bootstrap.panel.Content", + "sig" : "function (_self, width, height)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -827,8 +923,10 @@ }, { "name" : "deactivate", + "type" : "function", "desc" : "Fires when this panel is activated.", - "memberOf" : "Roo.bootstrap.panel.Content", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -845,8 +943,10 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires when this tab is created", - "memberOf" : "Roo.bootstrap.panel.Content", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -863,8 +963,10 @@ }, { "name" : "scroll", + "type" : "function", "desc" : "Fires when this content is scrolled", - "memberOf" : "Roo.bootstrap.panel.Content", + "sig" : "function (_self, scrollEvent)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.bootstrap.panel.Grid.json b/docs/symbols/Roo.bootstrap.panel.Grid.json index 5d42e8f95d..b4b9878492 100644 --- a/docs/symbols/Roo.bootstrap.panel.Grid.json +++ b/docs/symbols/Roo.bootstrap.panel.Grid.json @@ -22,166 +22,147 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "loadOnce", "type" : "Boolean", "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "badges", "type" : "Boolean", "desc" : "render the badges", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "autoScroll", "type" : "Boolean", "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "fitToFrame", "type" : "Boolean", "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "background", "type" : "Boolean", "desc" : "True if the panel should not be activated when it is added (defaults to false)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "toolbar", "type" : "Toolbar", "desc" : "A toolbar for this panel", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "region", "type" : "String", "desc" : "t) which region to put this panel on (when used with xtype constructors)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [ - "center", - "north", - "south", - "east", - "west" - ] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "content", "type" : "String", "desc" : "Raw content to fill content panel with (uses setContent on construction.)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "title", "type" : "String", "desc" : "The title for this panel", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "iframe", "type" : "Boolean", "desc" : "contents are an iframe - makes showing remote sources/CSS feasible..", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "cls", "type" : "String", "desc" : "extra classes to use", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "autoCreate", "type" : "Boolean/Object", "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "fitContainer", "type" : "Boolean", "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "grid", "type" : "Roo.bootstrap.Table", "desc" : "The grid for this panel", - "memberOf" : "Roo.bootstrap.panel.Grid", - "optvals" : [] + "memberOf" : "" }, { "name" : "closable", "type" : "Boolean", "desc" : "True if the panel can be closed/removed", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "params", "type" : "String/Object", "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "adjustments", "type" : "Array", "desc" : "Values to add to the width/height when doing a {@link #fitToFrame} (default is [0, 0])", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "url", "type" : "String", "desc" : "Calls {@link #setUrl} with this value", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "resizeEl", "type" : "String/HTMLElement/Element", "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" } ], "methods" : [ { "name" : "getGrid", + "type" : "function", "desc" : "Returns the grid for this panel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -193,29 +174,39 @@ }, { "name" : "refresh", + "type" : "function", "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getUpdateManager", + "type" : "function", "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -227,15 +218,20 @@ }, { "name" : "getChildContainer", + "type" : "function", "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n
\n\nlayout.addxtype({\n       xtype : 'Form',\n       items: [ .... ]\n   }\n);\n\n
", + "sig" : "(cfg)", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cfg", @@ -248,15 +244,20 @@ }, { "name" : "getToolbar", + "type" : "function", "desc" : "Returns the toolbar for this Panel if one was configured.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -268,15 +269,20 @@ }, { "name" : "setTitle", + "type" : "function", "desc" : "Set this panel's title", + "sig" : "(title)", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "title", @@ -289,15 +295,20 @@ }, { "name" : "setUrl", + "type" : "function", "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.", + "sig" : "(url, params, loadOnce)", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "url", @@ -328,15 +339,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns this panel's element - used by regiosn to add.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -348,29 +364,39 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Destroys this panel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "load", + "type" : "function", "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents", + "sig" : "(url, params, callback, discardUrl)", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "url", @@ -407,15 +433,20 @@ }, { "name" : "getTitle", + "type" : "function", "desc" : "Returns this panel's title", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -427,15 +458,20 @@ }, { "name" : "isClosable", + "type" : "function", "desc" : "Returns true is this panel was configured to be closable", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -447,15 +483,20 @@ }, { "name" : "getId", + "type" : "function", "desc" : "Returns this panel's id", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -467,15 +508,20 @@ }, { "name" : "setContent", + "type" : "function", "desc" : "Updates this panel's element (not for iframe)", + "sig" : "(content, loadScripts)", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "content", @@ -494,29 +540,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -547,15 +603,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -580,15 +641,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -601,15 +667,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -622,15 +693,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -655,15 +731,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -688,15 +769,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -715,15 +801,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -748,15 +839,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -789,7 +885,9 @@ "events" : [ { "name" : "activate", + "type" : "function", "desc" : "Fires when this panel is activated.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", @@ -807,7 +905,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires when this panel is resized if fitToFrame is true.", + "sig" : "function (_self, width, height)\n{\n\n}", "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", @@ -837,7 +937,9 @@ }, { "name" : "deactivate", + "type" : "function", "desc" : "Fires when this panel is activated.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", @@ -855,7 +957,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires when this tab is created", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", @@ -873,7 +977,9 @@ }, { "name" : "scroll", + "type" : "function", "desc" : "Fires when this content is scrolled", + "sig" : "function (_self, scrollEvent)\n{\n\n}", "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.bootstrap.panel.Nest.json b/docs/symbols/Roo.bootstrap.panel.Nest.json index 792a4693f8..a93f0df445 100644 --- a/docs/symbols/Roo.bootstrap.panel.Nest.json +++ b/docs/symbols/Roo.bootstrap.panel.Nest.json @@ -28,159 +28,141 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "loadOnce", "type" : "Boolean", "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "badges", "type" : "Boolean", "desc" : "render the badges", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "autoScroll", "type" : "Boolean", "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "fitToFrame", "type" : "Boolean", "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "background", "type" : "Boolean", "desc" : "True if the panel should not be activated when it is added (defaults to false)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "toolbar", "type" : "Toolbar", "desc" : "A toolbar for this panel", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "region", "type" : "String", "desc" : "t) which region to put this panel on (when used with xtype constructors)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [ - "center", - "north", - "south", - "east", - "west" - ] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "content", "type" : "String", "desc" : "Raw content to fill content panel with (uses setContent on construction.)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "title", "type" : "String", "desc" : "The title for this panel", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "iframe", "type" : "Boolean", "desc" : "contents are an iframe - makes showing remote sources/CSS feasible..", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "cls", "type" : "String", "desc" : "extra classes to use", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "autoCreate", "type" : "Boolean/Object", "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "fitContainer", "type" : "Boolean", "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "closable", "type" : "Boolean", "desc" : "True if the panel can be closed/removed", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "params", "type" : "String/Object", "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "adjustments", "type" : "Array", "desc" : "Values to add to the width/height when doing a {@link #fitToFrame} (default is [0, 0])", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "url", "type" : "String", "desc" : "Calls {@link #setUrl} with this value", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" }, { "name" : "resizeEl", "type" : "String/HTMLElement/Element", "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)", - "memberOf" : "Roo.bootstrap.panel.Content", - "optvals" : [] + "memberOf" : "Roo.bootstrap.panel.Content" } ], "methods" : [ { "name" : "getLayout", + "type" : "function", "desc" : "Returns the nested BorderLayout for this panel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Nest", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -192,15 +174,20 @@ }, { "name" : "addxtype", + "type" : "function", "desc" : "Adds a xtype elements to the layout of the nested panel\n
\n\npanel.addxtype({\n       xtype : 'ContentPanel',\n       region: 'west',\n       items: [ .... ]\n   }\n);\n\npanel.addxtype({\n        xtype : 'NestedLayoutPanel',\n        region: 'west',\n        layout: {\n           center: { },\n           west: { }   \n        },\n        items : [ ... list of content panels or nested layout panels.. ]\n   }\n);\n
", + "sig" : "(cfg)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Nest", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cfg", @@ -213,29 +200,39 @@ }, { "name" : "refresh", + "type" : "function", "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getUpdateManager", + "type" : "function", "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -247,15 +244,20 @@ }, { "name" : "getChildContainer", + "type" : "function", "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n
\n\nlayout.addxtype({\n       xtype : 'Form',\n       items: [ .... ]\n   }\n);\n\n
", + "sig" : "(cfg)", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cfg", @@ -268,15 +270,20 @@ }, { "name" : "getToolbar", + "type" : "function", "desc" : "Returns the toolbar for this Panel if one was configured.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -288,15 +295,20 @@ }, { "name" : "setTitle", + "type" : "function", "desc" : "Set this panel's title", + "sig" : "(title)", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "title", @@ -309,15 +321,20 @@ }, { "name" : "setUrl", + "type" : "function", "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.", + "sig" : "(url, params, loadOnce)", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "url", @@ -348,15 +365,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns this panel's element - used by regiosn to add.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -368,29 +390,39 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Destroys this panel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "load", + "type" : "function", "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents", + "sig" : "(url, params, callback, discardUrl)", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "url", @@ -427,15 +459,20 @@ }, { "name" : "getTitle", + "type" : "function", "desc" : "Returns this panel's title", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -447,15 +484,20 @@ }, { "name" : "isClosable", + "type" : "function", "desc" : "Returns true is this panel was configured to be closable", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -467,15 +509,20 @@ }, { "name" : "getId", + "type" : "function", "desc" : "Returns this panel's id", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -487,15 +534,20 @@ }, { "name" : "setContent", + "type" : "function", "desc" : "Updates this panel's element (not for iframe)", + "sig" : "(content, loadScripts)", + "static" : false, + "memberOf" : "Roo.bootstrap.panel.Content", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "content", @@ -514,29 +566,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -567,15 +629,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -600,15 +667,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -621,15 +693,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -642,15 +719,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -675,15 +757,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -708,15 +795,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -735,15 +827,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -768,15 +865,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -809,7 +911,9 @@ "events" : [ { "name" : "activate", + "type" : "function", "desc" : "Fires when this panel is activated.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", @@ -827,7 +931,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires when this panel is resized if fitToFrame is true.", + "sig" : "function (_self, width, height)\n{\n\n}", "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", @@ -857,7 +963,9 @@ }, { "name" : "deactivate", + "type" : "function", "desc" : "Fires when this panel is activated.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", @@ -875,7 +983,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires when this tab is created", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", @@ -893,7 +1003,9 @@ }, { "name" : "scroll", + "type" : "function", "desc" : "Fires when this content is scrolled", + "sig" : "function (_self, scrollEvent)\n{\n\n}", "memberOf" : "Roo.bootstrap.panel.Content", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.bootstrap.panel.TabItem.json b/docs/symbols/Roo.bootstrap.panel.TabItem.json index d1adc7f11d..75c416933e 100644 --- a/docs/symbols/Roo.bootstrap.panel.TabItem.json +++ b/docs/symbols/Roo.bootstrap.panel.TabItem.json @@ -39,55 +39,71 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" } ], "methods" : [ { "name" : "hide", + "type" : "function", "desc" : "Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.TabItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "show", + "type" : "function", "desc" : "Shows this TabPanelItem -- this does not deactivate the currently active TabPanelItem.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.TabItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isHidden", + "type" : "function", "desc" : "Returns true if this tab is \"hidden\"", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.TabItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -99,29 +115,39 @@ }, { "name" : "activate", + "type" : "function", "desc" : "Activates this TabPanelItem -- this does deactivate the currently active TabPanelItem.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.TabItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isActive", + "type" : "function", "desc" : "Returns true if this tab is the active tab.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.TabItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -133,29 +159,39 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.TabItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setUrl", + "type" : "function", "desc" : "Set a URL to be used to load the content for this TabPanelItem.", + "sig" : "(url, params, loadOnce)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.TabItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "url", @@ -186,15 +222,20 @@ }, { "name" : "setContent", + "type" : "function", "desc" : "Sets the content for this TabPanelItem.", + "sig" : "(content, loadScripts)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.TabItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "content", @@ -213,15 +254,20 @@ }, { "name" : "getUpdateManager", + "type" : "function", "desc" : "Gets the {@link Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.TabItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -233,15 +279,20 @@ }, { "name" : "setTooltip", + "type" : "function", "desc" : "Set the tooltip for the tab.", + "sig" : "(tooltip)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.TabItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "tooltip", @@ -254,15 +305,20 @@ }, { "name" : "getText", + "type" : "function", "desc" : "Returns the text for this tab", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.TabItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -274,15 +330,20 @@ }, { "name" : "setText", + "type" : "function", "desc" : "Sets the text for the tab (Note: this also sets the tooltip text)", + "sig" : "(text)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.TabItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "text", @@ -295,15 +356,20 @@ }, { "name" : "setHidden", + "type" : "function", "desc" : "Show or hide the tab", + "sig" : "(hidden)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.TabItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "hidden", @@ -316,57 +382,77 @@ }, { "name" : "refresh", + "type" : "function", "desc" : "Forces a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the setUrl method has not been called.\n This does not activate the panel, just updates its content.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.TabItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "enable", + "type" : "function", "desc" : "Enables this TabPanelItem if it was previously disabled.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.TabItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -397,15 +483,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -430,15 +521,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -451,15 +547,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -472,15 +573,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -505,15 +611,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -538,15 +649,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -565,15 +681,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -598,15 +719,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -639,8 +765,10 @@ "events" : [ { "name" : "close", + "type" : "function", "desc" : "Fires when this tab is closed.", - "memberOf" : "Roo.bootstrap.panel.TabItem", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -657,8 +785,10 @@ }, { "name" : "activate", + "type" : "function", "desc" : "Fires when this tab becomes the active tab.", - "memberOf" : "Roo.bootstrap.panel.TabItem", + "sig" : "function (tabPanel, _self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -681,8 +811,10 @@ }, { "name" : "beforeclose", + "type" : "function", "desc" : "Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true).", - "memberOf" : "Roo.bootstrap.panel.TabItem", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -705,8 +837,10 @@ }, { "name" : "deactivate", + "type" : "function", "desc" : "Fires when this tab is no longer the active tab.", - "memberOf" : "Roo.bootstrap.panel.TabItem", + "sig" : "function (tabPanel, _self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.bootstrap.panel.Tabs.json b/docs/symbols/Roo.bootstrap.panel.Tabs.json index 489a64caf1..939a53fcfb 100644 --- a/docs/symbols/Roo.bootstrap.panel.Tabs.json +++ b/docs/symbols/Roo.bootstrap.panel.Tabs.json @@ -27,27 +27,33 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" } ], "methods" : [ { "name" : "setTabWidth", + "type" : "function", "desc" : "Resizes all the tabs to the passed width", + "sig" : "(The)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Tabs", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "The", @@ -60,29 +66,39 @@ }, { "name" : "endUpdate", + "type" : "function", "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Tabs", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "disableTab", + "type" : "function", "desc" : "Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored.", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Tabs", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -95,15 +111,20 @@ }, { "name" : "getTab", + "type" : "function", "desc" : "Returns the {@link Roo.TabPanelItem} with the specified id/index", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Tabs", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -122,15 +143,20 @@ }, { "name" : "unhideTab", + "type" : "function", "desc" : "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index.", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Tabs", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -143,29 +169,39 @@ }, { "name" : "beginUpdate", + "type" : "function", "desc" : "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Tabs", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "enableTab", + "type" : "function", "desc" : "Enables a {@link Roo.TabPanelItem} that is disabled.", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Tabs", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -178,15 +214,20 @@ }, { "name" : "getCount", + "type" : "function", "desc" : "Returns the number of tabs in this TabPanel.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Tabs", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -198,15 +239,20 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Destroys this TabPanel", + "sig" : "(removeEl)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Tabs", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "removeEl", @@ -219,15 +265,20 @@ }, { "name" : "syncHeight", + "type" : "function", "desc" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling", + "sig" : "(targetHeight)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Tabs", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "targetHeight", @@ -240,15 +291,20 @@ }, { "name" : "activate", + "type" : "function", "desc" : "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated.", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Tabs", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -267,29 +323,39 @@ }, { "name" : "autoSizeTabs", + "type" : "function", "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Tabs", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "addTabItem", + "type" : "function", "desc" : "Adds an existing {@link Roo.TabPanelItem}.", + "sig" : "(item)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Tabs", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "item", @@ -302,15 +368,20 @@ }, { "name" : "addTab", + "type" : "function", "desc" : "Creates a new {@link Roo.TabPanelItem} by looking for an existing element with the provided id -- if it's not found it creates one.", + "sig" : "(id, text, content, closable)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Tabs", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -347,15 +418,20 @@ }, { "name" : "removeTab", + "type" : "function", "desc" : "Removes a {@link Roo.TabPanelItem}.", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Tabs", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -368,15 +444,20 @@ }, { "name" : "hideTab", + "type" : "function", "desc" : "Hides the {@link Roo.TabPanelItem} with the specified id/index", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Tabs", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -389,15 +470,20 @@ }, { "name" : "getActiveTab", + "type" : "function", "desc" : "Gets the active {@link Roo.TabPanelItem}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.bootstrap.panel.Tabs", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -409,29 +495,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -462,15 +558,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -495,15 +596,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -516,15 +622,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -537,15 +648,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -570,15 +686,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -603,15 +724,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -630,15 +756,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -663,15 +794,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -704,8 +840,10 @@ "events" : [ { "name" : "tabchange", + "type" : "function", "desc" : "Fires when the active tab changes", - "memberOf" : "Roo.bootstrap.panel.Tabs", + "sig" : "function (_self, activePanel)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -728,8 +866,10 @@ }, { "name" : "beforetabchange", + "type" : "function", "desc" : "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change", - "memberOf" : "Roo.bootstrap.panel.Tabs", + "sig" : "function (_self, e, tab)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.bootstrap.panel.json b/docs/symbols/Roo.bootstrap.panel.json index 66f0ab4c0d..c24e54c3f6 100644 --- a/docs/symbols/Roo.bootstrap.panel.json +++ b/docs/symbols/Roo.bootstrap.panel.json @@ -12,6 +12,8 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.data.ArrayReader.json b/docs/symbols/Roo.data.ArrayReader.json index e9470e01db..f655b409d4 100644 --- a/docs/symbols/Roo.data.ArrayReader.json +++ b/docs/symbols/Roo.data.ArrayReader.json @@ -27,34 +27,39 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "id", "type" : "String", "desc" : "Name of the property within a row object that contains a record identifier value.\nas specified to {@link Roo.data.Record#create},\nor an {@link Roo.data.Record} object\n\n\ncreated using {@link Roo.data.Record#create}.", - "memberOf" : "Roo.data.ArrayReader", - "optvals" : [] + "memberOf" : "" }, { "name" : "fields", "type" : "Array", "desc" : "Array of field definition objects", - "memberOf" : "Roo.data.ArrayReader", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "readRecords", + "type" : "function", "desc" : "Create a data block containing Roo.data.Records from an XML document.", + "sig" : "(o)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.ArrayReader", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -73,15 +78,20 @@ }, { "name" : "newRow", + "type" : "function", "desc" : "Create an empty record", + "sig" : "(data)", + "static" : false, + "memberOf" : "Roo.data.DataReader", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.DataReader", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "data", diff --git a/docs/symbols/Roo.data.Connection.json b/docs/symbols/Roo.data.Connection.json index a360ea5a5a..6bb7fd9fd2 100644 --- a/docs/symbols/Roo.data.Connection.json +++ b/docs/symbols/Roo.data.Connection.json @@ -21,76 +21,75 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "method", "type" : "String", "desc" : "(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)", - "memberOf" : "Roo.data.Connection", - "optvals" : [] + "memberOf" : "" }, { "name" : "timeout", "type" : "Number", "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)", - "memberOf" : "Roo.data.Connection", - "optvals" : [] + "memberOf" : "" }, { "name" : "autoAbort", "type" : "Boolean", "desc" : "(Optional) Whether this request should abort any pending requests. (defaults to false)", - "memberOf" : "Roo.data.Connection", - "optvals" : [] + "memberOf" : "" }, { "name" : "url", "type" : "String", "desc" : "(Optional) The default URL to be used for requests to the server. (defaults to undefined)", - "memberOf" : "Roo.data.Connection", - "optvals" : [] + "memberOf" : "" }, { "name" : "extraParams", "type" : "Object", "desc" : "(Optional) An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)", - "memberOf" : "Roo.data.Connection", - "optvals" : [] + "memberOf" : "" }, { "name" : "disableCaching", "type" : "Boolean", "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)", - "memberOf" : "Roo.data.Connection", - "optvals" : [] + "memberOf" : "" }, { "name" : "defaultHeaders", "type" : "Object", "desc" : "(Optional) An object containing request headers which are added\n to each request made by this object. (defaults to undefined)", - "memberOf" : "Roo.data.Connection", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "isLoading", + "type" : "function", "desc" : "Determine whether this object has a request outstanding.", + "sig" : "(transactionId)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Connection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "transactionId", @@ -109,15 +108,20 @@ }, { "name" : "request", + "type" : "function", "desc" : "Sends an HTTP request to a remote server.", + "sig" : "(options)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Connection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "options", @@ -136,15 +140,20 @@ }, { "name" : "abort", + "type" : "function", "desc" : "Aborts any outstanding request.", + "sig" : "(transactionId)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Connection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "transactionId", @@ -157,29 +166,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -210,15 +229,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -243,15 +267,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -264,15 +293,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -285,15 +319,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -318,15 +357,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -351,15 +395,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -378,15 +427,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -411,15 +465,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -452,8 +511,10 @@ "events" : [ { "name" : "requestcomplete", + "type" : "function", "desc" : "Fires if the request was successfully completed.", - "memberOf" : "Roo.data.Connection", + "sig" : "function (conn, response, options)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -482,8 +543,10 @@ }, { "name" : "beforerequest", + "type" : "function", "desc" : "Fires before a network request is made to retrieve a data object.", - "memberOf" : "Roo.data.Connection", + "sig" : "function (conn, options)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -506,8 +569,10 @@ }, { "name" : "requestexception", + "type" : "function", "desc" : "Fires if an error HTTP status was returned from the server.\nSee {@link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html} for details of HTTP status codes.", - "memberOf" : "Roo.data.Connection", + "sig" : "function (conn, response, options)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.data.DataProxy.json b/docs/symbols/Roo.data.DataProxy.json index 294373cb0b..d28c621b21 100644 --- a/docs/symbols/Roo.data.DataProxy.json +++ b/docs/symbols/Roo.data.DataProxy.json @@ -12,13 +12,17 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [ { "name" : "load", + "type" : "function", "desc" : "Fires before the load method's callback is called.", - "memberOf" : "Roo.data.DataProxy", + "sig" : "function (This, o, arg)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -47,8 +51,10 @@ }, { "name" : "beforeload", + "type" : "function", "desc" : "Fires before a network request is made to retrieve a data object.", - "memberOf" : "Roo.data.DataProxy", + "sig" : "function (This, params)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -71,8 +77,10 @@ }, { "name" : "loadexception", + "type" : "function", "desc" : "Fires if an Exception occurs during data retrieval.", - "memberOf" : "Roo.data.DataProxy", + "sig" : "function (This, o, arg, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.data.DataReader.json b/docs/symbols/Roo.data.DataReader.json index 11b2ddf2d0..70b4f61589 100644 --- a/docs/symbols/Roo.data.DataReader.json +++ b/docs/symbols/Roo.data.DataReader.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "newRow", + "type" : "function", "desc" : "Create an empty record", + "sig" : "(data)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.DataReader", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "data", diff --git a/docs/symbols/Roo.data.HttpProxy.json b/docs/symbols/Roo.data.HttpProxy.json index 35bb090ef6..4c8adf804c 100644 --- a/docs/symbols/Roo.data.HttpProxy.json +++ b/docs/symbols/Roo.data.HttpProxy.json @@ -21,69 +21,69 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "method", "type" : "String", "desc" : "(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)", - "memberOf" : "Roo.data.HttpProxy", - "optvals" : [] + "memberOf" : "" }, { "name" : "timeout", "type" : "Number", "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)", - "memberOf" : "Roo.data.HttpProxy", - "optvals" : [] + "memberOf" : "" }, { "name" : "autoAbort", "type" : "Boolean", "desc" : "(Optional) Whether this request should abort any pending requests. (defaults to false)", - "memberOf" : "Roo.data.HttpProxy", - "optvals" : [] + "memberOf" : "" }, { "name" : "url", "type" : "String", "desc" : "(Optional) The default URL to be used for requests to the server. (defaults to undefined)", - "memberOf" : "Roo.data.HttpProxy", - "optvals" : [] + "memberOf" : "" }, { "name" : "extraParams", "type" : "Object", "desc" : "(Optional) An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)", - "memberOf" : "Roo.data.HttpProxy", - "optvals" : [] + "memberOf" : "" }, { "name" : "disableCaching", "type" : "Boolean", "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)", - "memberOf" : "Roo.data.HttpProxy", - "optvals" : [] + "memberOf" : "" }, { "name" : "defaultHeaders", "type" : "Object", "desc" : "(Optional) An object containing request headers which are added\n to each request made by this object. (defaults to undefined)", - "memberOf" : "Roo.data.HttpProxy", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "getConnection", + "type" : "function", "desc" : "Return the {@link Roo.data.Connection} object being used by this Proxy.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.HttpProxy", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -95,15 +95,20 @@ }, { "name" : "load", + "type" : "function", "desc" : "Load data from the configured {@link Roo.data.Connection}, read the data object into\na block of Roo.data.Records using the passed {@link Roo.data.DataReader} implementation, and\nprocess that block using the passed callback.", + "sig" : "(params, reader, callback, scope, arg)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.HttpProxy", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "params", @@ -142,7 +147,9 @@ "events" : [ { "name" : "load", + "type" : "function", "desc" : "Fires before the load method's callback is called.", + "sig" : "function (This, o, arg)\n{\n\n}", "memberOf" : "Roo.data.DataProxy", "example" : "", "deprecated" : "", @@ -172,7 +179,9 @@ }, { "name" : "beforeload", + "type" : "function", "desc" : "Fires before a network request is made to retrieve a data object.", + "sig" : "function (This, params)\n{\n\n}", "memberOf" : "Roo.data.DataProxy", "example" : "", "deprecated" : "", @@ -196,7 +205,9 @@ }, { "name" : "loadexception", + "type" : "function", "desc" : "Fires if an Exception occurs during data retrieval.", + "sig" : "function (This, o, arg, e)\n{\n\n}", "memberOf" : "Roo.data.DataProxy", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.data.JsonReader.json b/docs/symbols/Roo.data.JsonReader.json index 12fcb39398..9ec74de137 100644 --- a/docs/symbols/Roo.data.JsonReader.json +++ b/docs/symbols/Roo.data.JsonReader.json @@ -27,55 +27,57 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "id", "type" : "String", "desc" : "Name of the property within a row object that contains a record identifier value.", - "memberOf" : "Roo.data.JsonReader", - "optvals" : [] + "memberOf" : "" }, { "name" : "fields", "type" : "Array", "desc" : "Array of field definition objects", - "memberOf" : "Roo.data.JsonReader", - "optvals" : [] + "memberOf" : "" }, { "name" : "root", "type" : "String", "desc" : "name of the property which contains the Array of row objects.", - "memberOf" : "Roo.data.JsonReader", - "optvals" : [] + "memberOf" : "" }, { "name" : "successProperty", "type" : "String", "desc" : "Name of the property from which to retrieve the success attribute used by forms.", - "memberOf" : "Roo.data.JsonReader", - "optvals" : [] + "memberOf" : "" }, { "name" : "totalProperty", "type" : "String", "desc" : "Name of the property from which to retrieve the total number of records\nin the dataset. This is only needed if the whole dataset is not passed in one go, but is being\npaged from the remote server.", - "memberOf" : "Roo.data.JsonReader", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "readRecords", + "type" : "function", "desc" : "Create a data block containing Roo.data.Records from an XML document.", + "sig" : "(o)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.JsonReader", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -94,15 +96,20 @@ }, { "name" : "read", + "type" : "function", "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.", + "sig" : "(response)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.JsonReader", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "response", @@ -121,15 +128,20 @@ }, { "name" : "newRow", + "type" : "function", "desc" : "Create an empty record", + "sig" : "(data)", + "static" : false, + "memberOf" : "Roo.data.DataReader", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.DataReader", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "data", diff --git a/docs/symbols/Roo.data.JsonStore.json b/docs/symbols/Roo.data.JsonStore.json index 68aa611af1..eed3f90d6c 100644 --- a/docs/symbols/Roo.data.JsonStore.json +++ b/docs/symbols/Roo.data.JsonStore.json @@ -22,97 +22,93 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "fields", "type" : "Array", "desc" : "An array of field definition objects, or field name strings.", - "memberOf" : "Roo.data.JsonStore", - "optvals" : [] + "memberOf" : "" }, { "name" : "proxy", "type" : "Roo.data.DataProxy", - "desc" : "The Proxy object which provides access to a data object.", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "desc" : "[required] The Proxy object which provides access to a data object.", + "memberOf" : "Roo.data.Store" }, { "name" : "multiSort", "type" : "Boolean", "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "memberOf" : "Roo.data.Store" }, { "name" : "pruneModifiedRecords", "type" : "boolean", "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "memberOf" : "Roo.data.Store" }, { "name" : "remoteSort", "type" : "boolean", "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "memberOf" : "Roo.data.Store" }, { "name" : "data", "type" : "Array", "desc" : "Inline data to be loaded when the store is initialized.", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "memberOf" : "Roo.data.Store" }, { "name" : "sortInfo", "type" : "Object", "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "memberOf" : "Roo.data.Store" }, { "name" : "baseParams", "type" : "Object", "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "memberOf" : "Roo.data.Store" }, { "name" : "reader", - "type" : "Roo.data.Reader", - "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their id property.", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "type" : "Roo.data.DataReader", + "desc" : "[required] The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their id property.", + "memberOf" : "Roo.data.Store" }, { "name" : "isLocal", "type" : "boolean", "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "memberOf" : "Roo.data.Store" } ], "methods" : [ { "name" : "reload", + "type" : "function", "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.", + "sig" : "(options)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "options", @@ -125,29 +121,39 @@ }, { "name" : "removeAll", + "type" : "function", "desc" : "Remove all Records from the Store and fires the clear event.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "query", + "type" : "function", "desc" : "Query the records by a specified property.", + "sig" : "(field, value, anyMatch)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "field", @@ -178,15 +184,20 @@ }, { "name" : "sum", + "type" : "function", "desc" : "Sums the value of property for each record between start and end and returns the result.", + "sig" : "(property, start, end)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "property", @@ -217,15 +228,20 @@ }, { "name" : "getById", + "type" : "function", "desc" : "Get the Record with the specified id.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -244,43 +260,58 @@ }, { "name" : "commitChanges", + "type" : "function", "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getCount", + "type" : "function", "desc" : "Gets the number of cached records.\n

\nIf using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "indexOf", + "type" : "function", "desc" : "Get the index within the cache of the passed Record.", + "sig" : "(record)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "record", @@ -299,15 +330,20 @@ }, { "name" : "add", + "type" : "function", "desc" : "Add Records to the Store and fires the add event.", + "sig" : "(records)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "records", @@ -320,15 +356,20 @@ }, { "name" : "indexOfId", + "type" : "function", "desc" : "Get the index within the cache of the Record with the passed id.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -347,15 +388,20 @@ }, { "name" : "filter", + "type" : "function", "desc" : "Filter the records by a specified property.", + "sig" : "(field, value, anyMatch)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "field", @@ -380,15 +426,20 @@ }, { "name" : "sort", + "type" : "function", "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.", + "sig" : "(fieldName, dir)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fieldName", @@ -407,15 +458,20 @@ }, { "name" : "getRange", + "type" : "function", "desc" : "Returns a range of Records between specified indices.", + "sig" : "(startIndex, endIndex)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "startIndex", @@ -440,15 +496,20 @@ }, { "name" : "queryBy", + "type" : "function", "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -473,15 +534,20 @@ }, { "name" : "loadDataFromChildren", + "type" : "function", "desc" : "using 'cn' the nested child reader read the child array into it's child stores.", + "sig" : "(rec)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "rec", @@ -494,15 +560,20 @@ }, { "name" : "clearFilter", + "type" : "function", "desc" : "Revert to a view of the Record cache with no filtering applied.", + "sig" : "(suppressEvent)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "suppressEvent", @@ -515,15 +586,20 @@ }, { "name" : "each", + "type" : "function", "desc" : "Calls the specified function for each of the Records in the cache.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -542,29 +618,39 @@ }, { "name" : "rejectChanges", + "type" : "function", "desc" : "Cancel outstanding changes on all changed records.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getAt", + "type" : "function", "desc" : "Get the Record at the specified index.", + "sig" : "(index)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -583,29 +669,39 @@ }, { "name" : "getTotalCount", + "type" : "function", "desc" : "Gets the total number of records in the dataset as returned by the server.\n

\nIf using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "filterBy", + "type" : "function", "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -624,15 +720,20 @@ }, { "name" : "collect", + "type" : "function", "desc" : "Collects unique values for a particular dataIndex from this store.", + "sig" : "(dataIndex, allowNull, bypassFilter)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "dataIndex", @@ -663,15 +764,20 @@ }, { "name" : "getModifiedRecords", + "type" : "function", "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -683,15 +789,20 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Remove a Record from the Store and fires the remove event.", + "sig" : "(record)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "record", @@ -704,15 +815,20 @@ }, { "name" : "loadData", + "type" : "function", "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.", + "sig" : "(data, append)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "data", @@ -731,15 +847,20 @@ }, { "name" : "load", + "type" : "function", "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n

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

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

", + "sig" : "(options)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "options", @@ -752,15 +873,20 @@ }, { "name" : "setDefaultSort", + "type" : "function", "desc" : "Sets the default sort column and order to be used by the next load operation.", + "sig" : "(fieldName, dir)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fieldName", @@ -779,15 +905,20 @@ }, { "name" : "insert", + "type" : "function", "desc" : "Inserts Records to the Store at the given index and fires the add event.", + "sig" : "(index, records)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -806,43 +937,58 @@ }, { "name" : "getSortState", + "type" : "function", "desc" : "Returns the sort state of the Store as an object with two properties:\n

\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n
", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -873,15 +1019,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -906,15 +1057,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -927,15 +1083,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -948,15 +1109,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -981,15 +1147,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1014,15 +1185,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1041,15 +1217,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1074,15 +1255,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1115,7 +1301,9 @@ "events" : [ { "name" : "beforeloadadd", + "type" : "function", "desc" : "Fires after a new set of Records has been loaded.", + "sig" : "function (_self, records, options)\n{\n\n}", "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", @@ -1145,7 +1333,9 @@ }, { "name" : "loadexception", + "type" : "function", "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args", + "sig" : "function (, return, load, jsonData)\n{\n\n}", "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", @@ -1181,7 +1371,9 @@ }, { "name" : "load", + "type" : "function", "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.", + "sig" : "function (_self, records, options)\n{\n\n}", "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", @@ -1211,7 +1403,9 @@ }, { "name" : "add", + "type" : "function", "desc" : "Fires when Records have been added to the Store", + "sig" : "function (_self, records, index)\n{\n\n}", "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", @@ -1241,7 +1435,9 @@ }, { "name" : "metachange", + "type" : "function", "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.", + "sig" : "function (_self, meta)\n{\n\n}", "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", @@ -1265,7 +1461,9 @@ }, { "name" : "clear", + "type" : "function", "desc" : "Fires when the data cache has been cleared.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", @@ -1283,7 +1481,9 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Fires when a Record has been removed from the Store", + "sig" : "function (_self, record, index)\n{\n\n}", "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", @@ -1313,7 +1513,9 @@ }, { "name" : "update", + "type" : "function", "desc" : "Fires when a Record has been updated", + "sig" : "function (_self, record, operation)\n{\n\n}", "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", @@ -1343,7 +1545,9 @@ }, { "name" : "beforeload", + "type" : "function", "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.", + "sig" : "function (_self, options)\n{\n\n}", "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", @@ -1367,7 +1571,9 @@ }, { "name" : "datachanged", + "type" : "function", "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.data.MemoryProxy.json b/docs/symbols/Roo.data.MemoryProxy.json index e8fed7fa08..4886468985 100644 --- a/docs/symbols/Roo.data.MemoryProxy.json +++ b/docs/symbols/Roo.data.MemoryProxy.json @@ -19,19 +19,26 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "load", + "type" : "function", "desc" : "Load data from the requested source (in this case an in-memory\ndata object passed to the constructor), read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.", + "sig" : "(params, reader, callback, scope, arg)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.MemoryProxy", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "params", diff --git a/docs/symbols/Roo.data.Node.json b/docs/symbols/Roo.data.Node.json index 169113686c..ce9b8fd074 100644 --- a/docs/symbols/Roo.data.Node.json +++ b/docs/symbols/Roo.data.Node.json @@ -21,41 +21,45 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "id", "type" : "String", "desc" : "The id for this node. If one is not specified, one is generated.", - "memberOf" : "Roo.data.Node", - "optvals" : [] + "memberOf" : "" }, { "name" : "leaf", "type" : "Boolean", "desc" : "true if this node is a leaf and does not have children", - "memberOf" : "Roo.data.Node", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "sort", + "type" : "function", "desc" : "Sorts this nodes children using the supplied sort function", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -74,15 +78,20 @@ }, { "name" : "removeChild", + "type" : "function", "desc" : "Removes a child node from this node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -101,15 +110,20 @@ }, { "name" : "isAncestor", + "type" : "function", "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -128,15 +142,20 @@ }, { "name" : "contains", + "type" : "function", "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -155,15 +174,20 @@ }, { "name" : "cascade", + "type" : "function", "desc" : "Cascades down the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch.", + "sig" : "(fn, scope, args)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -188,15 +212,20 @@ }, { "name" : "getDepth", + "type" : "function", "desc" : "Returns depth of this node (the root node has a depth of 0)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -208,15 +237,20 @@ }, { "name" : "getPath", + "type" : "function", "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.", + "sig" : "(attr)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "attr", @@ -235,15 +269,20 @@ }, { "name" : "indexOf", + "type" : "function", "desc" : "Returns the index of a child node", + "sig" : "(node)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -262,15 +301,20 @@ }, { "name" : "isFirst", + "type" : "function", "desc" : "Returns true if this node is the first child of its parent", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -282,15 +326,20 @@ }, { "name" : "isLast", + "type" : "function", "desc" : "Returns true if this node is the last child of its parent", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -302,15 +351,20 @@ }, { "name" : "isLeaf", + "type" : "function", "desc" : "Returns true if this node is a leaf", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -322,15 +376,20 @@ }, { "name" : "insertBefore", + "type" : "function", "desc" : "Inserts the first node before the second node in this nodes childNodes collection.", + "sig" : "(node, refNode)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -355,15 +414,20 @@ }, { "name" : "item", + "type" : "function", "desc" : "Returns the child node at the specified index.", + "sig" : "(index)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -382,15 +446,20 @@ }, { "name" : "getOwnerTree", + "type" : "function", "desc" : "Returns the tree this node is in.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -402,15 +471,20 @@ }, { "name" : "appendChild", + "type" : "function", "desc" : "Insert node(s) as the last child node of this node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -429,15 +503,20 @@ }, { "name" : "findChildBy", + "type" : "function", "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -462,15 +541,20 @@ }, { "name" : "replaceChild", + "type" : "function", "desc" : "Replaces one child node in this node with another.", + "sig" : "(newChild, oldChild)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "newChild", @@ -495,15 +579,20 @@ }, { "name" : "bubble", + "type" : "function", "desc" : "Bubbles up the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped.", + "sig" : "(fn, scope, args)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -528,15 +617,20 @@ }, { "name" : "eachChild", + "type" : "function", "desc" : "Interates the child nodes of this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops.", + "sig" : "(fn, scope, args)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -561,15 +655,20 @@ }, { "name" : "findChild", + "type" : "function", "desc" : "Finds the first child that has the attribute with the specified value.", + "sig" : "(attribute, value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "attribute", @@ -594,29 +693,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -647,15 +756,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -680,15 +794,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -701,15 +820,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -722,15 +846,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -755,15 +884,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -788,15 +922,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -815,15 +954,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -848,15 +992,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -889,8 +1038,10 @@ "events" : [ { "name" : "beforeappend", + "type" : "function", "desc" : "Fires before a new child is appended, return false to cancel the append.", - "memberOf" : "Roo.data.Node", + "sig" : "function (tree, _self, node)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -919,8 +1070,10 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires when this node is moved to a new location in the tree", - "memberOf" : "Roo.data.Node", + "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -961,8 +1114,10 @@ }, { "name" : "append", + "type" : "function", "desc" : "Fires when a new child node is appended", - "memberOf" : "Roo.data.Node", + "sig" : "function (tree, _self, node, index)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -997,8 +1152,10 @@ }, { "name" : "beforeremove", + "type" : "function", "desc" : "Fires before a child is removed, return false to cancel the remove.", - "memberOf" : "Roo.data.Node", + "sig" : "function (tree, _self, node)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1027,8 +1184,10 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Fires when a child node is removed", - "memberOf" : "Roo.data.Node", + "sig" : "function (tree, _self, node)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1057,8 +1216,10 @@ }, { "name" : "beforeinsert", + "type" : "function", "desc" : "Fires before a new child is inserted, return false to cancel the insert.", - "memberOf" : "Roo.data.Node", + "sig" : "function (tree, _self, node, refNode)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1093,8 +1254,10 @@ }, { "name" : "insert", + "type" : "function", "desc" : "Fires when a new child node is inserted.", - "memberOf" : "Roo.data.Node", + "sig" : "function (tree, _self, node, refNode)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1129,8 +1292,10 @@ }, { "name" : "beforemove", + "type" : "function", "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.", - "memberOf" : "Roo.data.Node", + "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.data.Record.json b/docs/symbols/Roo.data.Record.json index 594f9e06b7..a33d2a76b5 100644 --- a/docs/symbols/Roo.data.Record.json +++ b/docs/symbols/Roo.data.Record.json @@ -25,19 +25,26 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "copy", + "type" : "function", "desc" : "Creates a copy of this record.", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Record", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -56,29 +63,39 @@ }, { "name" : "commit", + "type" : "function", "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nCommits all changes made to the Record since either creation, or the last commit operation.\n

\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof commit operations.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Record", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "get", + "type" : "function", "desc" : "Get the value of the named field.", + "sig" : "(name)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Record", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "name", @@ -97,15 +114,20 @@ }, { "name" : "set", + "type" : "function", "desc" : "Set the named field to the specified value.", + "sig" : "(name, value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Record", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "name", @@ -124,29 +146,39 @@ }, { "name" : "reject", + "type" : "function", "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nRejects all changes made to the Record since either creation, or the last commit operation.\nModified fields are reverted to their original values.\n

\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof reject operations.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Record", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "create", + "type" : "function", "desc" : "Generate a constructor for a specific record layout.", + "sig" : "(o)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Record", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", diff --git a/docs/symbols/Roo.data.ScriptTagProxy.json b/docs/symbols/Roo.data.ScriptTagProxy.json index d670504288..3696615632 100644 --- a/docs/symbols/Roo.data.ScriptTagProxy.json +++ b/docs/symbols/Roo.data.ScriptTagProxy.json @@ -19,62 +19,70 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "timeout", "type" : "Number", "desc" : "(Optional) The number of milliseconds to wait for a response. Defaults to 30 seconds.", - "memberOf" : "Roo.data.ScriptTagProxy", - "optvals" : [] + "memberOf" : "" }, { "name" : "nocache", "type" : "Boolean", "desc" : "(Optional) Defaults to true. Disable cacheing by adding a unique parameter\nname to the request.", - "memberOf" : "Roo.data.ScriptTagProxy", - "optvals" : [] + "memberOf" : "" }, { "name" : "callbackParam", "type" : "String", "desc" : "(Optional) The name of the parameter to pass to the server which tells\nthe server the name of the callback function set up by the load call to process the returned data object.\nDefaults to \"callback\".

The server-side processing must read this parameter value, and generate\njavascript output which calls this named function passing the data object as its only parameter.", - "memberOf" : "Roo.data.ScriptTagProxy", - "optvals" : [] + "memberOf" : "" }, { "name" : "url", "type" : "String", "desc" : "The URL from which to request the data object.", - "memberOf" : "Roo.data.ScriptTagProxy", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "abort", + "type" : "function", "desc" : "Abort the current server request.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.ScriptTagProxy", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "load", + "type" : "function", "desc" : "Load data from the configured URL, read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.", + "sig" : "(params, reader, callback, scope, arg)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.ScriptTagProxy", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "params", diff --git a/docs/symbols/Roo.data.SimpleStore.json b/docs/symbols/Roo.data.SimpleStore.json index 7d7544c597..fb23a911b9 100644 --- a/docs/symbols/Roo.data.SimpleStore.json +++ b/docs/symbols/Roo.data.SimpleStore.json @@ -22,111 +22,105 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "an", "type" : "Object", "desc" : "existing reader (eg. copied from another store)", - "memberOf" : "Roo.data.SimpleStore", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "id", "type" : "Number", "desc" : "The array index of the record id. Leave blank to auto generate ids.", - "memberOf" : "Roo.data.SimpleStore", - "optvals" : [] + "memberOf" : "" }, { "name" : "fields", "type" : "Array", "desc" : "An array of field definition objects, or field name strings.", - "memberOf" : "Roo.data.SimpleStore", - "optvals" : [] + "memberOf" : "" }, { "name" : "proxy", "type" : "Roo.data.DataProxy", - "desc" : "The Proxy object which provides access to a data object.", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "desc" : "[not-required]", + "memberOf" : "" }, { "name" : "multiSort", "type" : "Boolean", "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "memberOf" : "Roo.data.Store" }, { "name" : "pruneModifiedRecords", "type" : "boolean", "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "memberOf" : "Roo.data.Store" }, { "name" : "remoteSort", "type" : "boolean", "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "memberOf" : "Roo.data.Store" }, { "name" : "data", "type" : "Array", "desc" : "The multi-dimensional array of data", - "memberOf" : "Roo.data.SimpleStore", - "optvals" : [] + "memberOf" : "" }, { "name" : "sortInfo", "type" : "Object", "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "memberOf" : "Roo.data.Store" }, { "name" : "baseParams", "type" : "Object", "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "memberOf" : "Roo.data.Store" }, { "name" : "reader", "type" : "Roo.data.Reader", - "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their id property.", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "desc" : "[not-required]", + "memberOf" : "" }, { "name" : "isLocal", "type" : "boolean", "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "memberOf" : "Roo.data.Store" } ], "methods" : [ { "name" : "reload", + "type" : "function", "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.", + "sig" : "(options)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "options", @@ -139,29 +133,39 @@ }, { "name" : "removeAll", + "type" : "function", "desc" : "Remove all Records from the Store and fires the clear event.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "query", + "type" : "function", "desc" : "Query the records by a specified property.", + "sig" : "(field, value, anyMatch)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "field", @@ -192,15 +196,20 @@ }, { "name" : "sum", + "type" : "function", "desc" : "Sums the value of property for each record between start and end and returns the result.", + "sig" : "(property, start, end)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "property", @@ -231,15 +240,20 @@ }, { "name" : "getById", + "type" : "function", "desc" : "Get the Record with the specified id.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -258,43 +272,58 @@ }, { "name" : "commitChanges", + "type" : "function", "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getCount", + "type" : "function", "desc" : "Gets the number of cached records.\n

\nIf using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "indexOf", + "type" : "function", "desc" : "Get the index within the cache of the passed Record.", + "sig" : "(record)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "record", @@ -313,15 +342,20 @@ }, { "name" : "add", + "type" : "function", "desc" : "Add Records to the Store and fires the add event.", + "sig" : "(records)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "records", @@ -334,15 +368,20 @@ }, { "name" : "indexOfId", + "type" : "function", "desc" : "Get the index within the cache of the Record with the passed id.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -361,15 +400,20 @@ }, { "name" : "filter", + "type" : "function", "desc" : "Filter the records by a specified property.", + "sig" : "(field, value, anyMatch)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "field", @@ -394,15 +438,20 @@ }, { "name" : "sort", + "type" : "function", "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.", + "sig" : "(fieldName, dir)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fieldName", @@ -421,15 +470,20 @@ }, { "name" : "getRange", + "type" : "function", "desc" : "Returns a range of Records between specified indices.", + "sig" : "(startIndex, endIndex)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "startIndex", @@ -454,15 +508,20 @@ }, { "name" : "queryBy", + "type" : "function", "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -487,15 +546,20 @@ }, { "name" : "loadDataFromChildren", + "type" : "function", "desc" : "using 'cn' the nested child reader read the child array into it's child stores.", + "sig" : "(rec)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "rec", @@ -508,15 +572,20 @@ }, { "name" : "clearFilter", + "type" : "function", "desc" : "Revert to a view of the Record cache with no filtering applied.", + "sig" : "(suppressEvent)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "suppressEvent", @@ -529,15 +598,20 @@ }, { "name" : "each", + "type" : "function", "desc" : "Calls the specified function for each of the Records in the cache.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -556,29 +630,39 @@ }, { "name" : "rejectChanges", + "type" : "function", "desc" : "Cancel outstanding changes on all changed records.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getAt", + "type" : "function", "desc" : "Get the Record at the specified index.", + "sig" : "(index)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -597,29 +681,39 @@ }, { "name" : "getTotalCount", + "type" : "function", "desc" : "Gets the total number of records in the dataset as returned by the server.\n

\nIf using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "filterBy", + "type" : "function", "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -638,15 +732,20 @@ }, { "name" : "collect", + "type" : "function", "desc" : "Collects unique values for a particular dataIndex from this store.", + "sig" : "(dataIndex, allowNull, bypassFilter)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "dataIndex", @@ -677,15 +776,20 @@ }, { "name" : "getModifiedRecords", + "type" : "function", "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -697,15 +801,20 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Remove a Record from the Store and fires the remove event.", + "sig" : "(record)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "record", @@ -718,15 +827,20 @@ }, { "name" : "loadData", + "type" : "function", "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.", + "sig" : "(data, append)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "data", @@ -745,15 +859,20 @@ }, { "name" : "load", + "type" : "function", "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n

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

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

", + "sig" : "(options)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "options", @@ -766,15 +885,20 @@ }, { "name" : "setDefaultSort", + "type" : "function", "desc" : "Sets the default sort column and order to be used by the next load operation.", + "sig" : "(fieldName, dir)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fieldName", @@ -793,15 +917,20 @@ }, { "name" : "insert", + "type" : "function", "desc" : "Inserts Records to the Store at the given index and fires the add event.", + "sig" : "(index, records)", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -820,43 +949,58 @@ }, { "name" : "getSortState", + "type" : "function", "desc" : "Returns the sort state of the Store as an object with two properties:\n

\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n
", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Store", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -887,15 +1031,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -920,15 +1069,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -941,15 +1095,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -962,15 +1121,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -995,15 +1159,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1028,15 +1197,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1055,15 +1229,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1088,15 +1267,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1129,7 +1313,9 @@ "events" : [ { "name" : "beforeloadadd", + "type" : "function", "desc" : "Fires after a new set of Records has been loaded.", + "sig" : "function (_self, records, options)\n{\n\n}", "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", @@ -1159,7 +1345,9 @@ }, { "name" : "loadexception", + "type" : "function", "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args", + "sig" : "function (, return, load, jsonData)\n{\n\n}", "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", @@ -1195,7 +1383,9 @@ }, { "name" : "load", + "type" : "function", "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.", + "sig" : "function (_self, records, options)\n{\n\n}", "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", @@ -1225,7 +1415,9 @@ }, { "name" : "add", + "type" : "function", "desc" : "Fires when Records have been added to the Store", + "sig" : "function (_self, records, index)\n{\n\n}", "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", @@ -1255,7 +1447,9 @@ }, { "name" : "metachange", + "type" : "function", "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.", + "sig" : "function (_self, meta)\n{\n\n}", "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", @@ -1279,7 +1473,9 @@ }, { "name" : "clear", + "type" : "function", "desc" : "Fires when the data cache has been cleared.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", @@ -1297,7 +1493,9 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Fires when a Record has been removed from the Store", + "sig" : "function (_self, record, index)\n{\n\n}", "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", @@ -1327,7 +1525,9 @@ }, { "name" : "update", + "type" : "function", "desc" : "Fires when a Record has been updated", + "sig" : "function (_self, record, operation)\n{\n\n}", "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", @@ -1357,7 +1557,9 @@ }, { "name" : "beforeload", + "type" : "function", "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.", + "sig" : "function (_self, options)\n{\n\n}", "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", @@ -1381,7 +1583,9 @@ }, { "name" : "datachanged", + "type" : "function", "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.data.SortTypes.json b/docs/symbols/Roo.data.SortTypes.json index cdab02488d..32fe2bfbd4 100644 --- a/docs/symbols/Roo.data.SortTypes.json +++ b/docs/symbols/Roo.data.SortTypes.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "asFloat", + "type" : "function", "desc" : "Float sorting", + "sig" : "(s)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.SortTypes", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "s", @@ -43,15 +50,20 @@ }, { "name" : "asUCString", + "type" : "function", "desc" : "Case insensitive string", + "sig" : "(s)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.SortTypes", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "s", @@ -70,15 +82,20 @@ }, { "name" : "asDate", + "type" : "function", "desc" : "Date sorting", + "sig" : "(s)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.SortTypes", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "s", @@ -97,15 +114,20 @@ }, { "name" : "asUCText", + "type" : "function", "desc" : "Strips all HTML tags to sort on text only - Case insensitive", + "sig" : "(s)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.SortTypes", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "s", @@ -124,15 +146,20 @@ }, { "name" : "asInt", + "type" : "function", "desc" : "Integer sorting", + "sig" : "(s)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.SortTypes", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "s", @@ -151,15 +178,20 @@ }, { "name" : "asText", + "type" : "function", "desc" : "Strips all HTML tags to sort on text only", + "sig" : "(s)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.SortTypes", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "s", @@ -178,15 +210,20 @@ }, { "name" : "none", + "type" : "function", "desc" : "Default sort that does nothing", + "sig" : "(s)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.SortTypes", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "s", diff --git a/docs/symbols/Roo.data.Store.json b/docs/symbols/Roo.data.Store.json index b5e2311952..7e92ddaacb 100644 --- a/docs/symbols/Roo.data.Store.json +++ b/docs/symbols/Roo.data.Store.json @@ -21,90 +21,87 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "proxy", "type" : "Roo.data.DataProxy", - "desc" : "The Proxy object which provides access to a data object.", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "desc" : "[required] The Proxy object which provides access to a data object.", + "memberOf" : "" }, { "name" : "multiSort", "type" : "Boolean", "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "memberOf" : "" }, { "name" : "pruneModifiedRecords", "type" : "boolean", "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "memberOf" : "" }, { "name" : "remoteSort", "type" : "boolean", "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "memberOf" : "" }, { "name" : "data", "type" : "Array", "desc" : "Inline data to be loaded when the store is initialized.", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "memberOf" : "" }, { "name" : "sortInfo", "type" : "Object", "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "memberOf" : "" }, { "name" : "baseParams", "type" : "Object", "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "memberOf" : "" }, { "name" : "reader", - "type" : "Roo.data.Reader", - "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their id property.", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "type" : "Roo.data.DataReader", + "desc" : "[required] The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their id property.", + "memberOf" : "" }, { "name" : "isLocal", "type" : "boolean", "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.", - "memberOf" : "Roo.data.Store", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "reload", + "type" : "function", "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.", + "sig" : "(options)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "options", @@ -117,29 +114,39 @@ }, { "name" : "removeAll", + "type" : "function", "desc" : "Remove all Records from the Store and fires the clear event.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "query", + "type" : "function", "desc" : "Query the records by a specified property.", + "sig" : "(field, value, anyMatch)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "field", @@ -170,15 +177,20 @@ }, { "name" : "sum", + "type" : "function", "desc" : "Sums the value of property for each record between start and end and returns the result.", + "sig" : "(property, start, end)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "property", @@ -209,15 +221,20 @@ }, { "name" : "getById", + "type" : "function", "desc" : "Get the Record with the specified id.", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -236,43 +253,58 @@ }, { "name" : "commitChanges", + "type" : "function", "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getCount", + "type" : "function", "desc" : "Gets the number of cached records.\n

\nIf using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "indexOf", + "type" : "function", "desc" : "Get the index within the cache of the passed Record.", + "sig" : "(record)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "record", @@ -291,15 +323,20 @@ }, { "name" : "add", + "type" : "function", "desc" : "Add Records to the Store and fires the add event.", + "sig" : "(records)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "records", @@ -312,15 +349,20 @@ }, { "name" : "indexOfId", + "type" : "function", "desc" : "Get the index within the cache of the Record with the passed id.", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -339,15 +381,20 @@ }, { "name" : "filter", + "type" : "function", "desc" : "Filter the records by a specified property.", + "sig" : "(field, value, anyMatch)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "field", @@ -372,15 +419,20 @@ }, { "name" : "sort", + "type" : "function", "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.", + "sig" : "(fieldName, dir)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fieldName", @@ -399,15 +451,20 @@ }, { "name" : "getRange", + "type" : "function", "desc" : "Returns a range of Records between specified indices.", + "sig" : "(startIndex, endIndex)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "startIndex", @@ -432,15 +489,20 @@ }, { "name" : "queryBy", + "type" : "function", "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -465,15 +527,20 @@ }, { "name" : "loadDataFromChildren", + "type" : "function", "desc" : "using 'cn' the nested child reader read the child array into it's child stores.", + "sig" : "(rec)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "rec", @@ -486,15 +553,20 @@ }, { "name" : "clearFilter", + "type" : "function", "desc" : "Revert to a view of the Record cache with no filtering applied.", + "sig" : "(suppressEvent)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "suppressEvent", @@ -507,15 +579,20 @@ }, { "name" : "each", + "type" : "function", "desc" : "Calls the specified function for each of the Records in the cache.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -534,29 +611,39 @@ }, { "name" : "rejectChanges", + "type" : "function", "desc" : "Cancel outstanding changes on all changed records.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getAt", + "type" : "function", "desc" : "Get the Record at the specified index.", + "sig" : "(index)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -575,29 +662,39 @@ }, { "name" : "getTotalCount", + "type" : "function", "desc" : "Gets the total number of records in the dataset as returned by the server.\n

\nIf using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "filterBy", + "type" : "function", "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -616,15 +713,20 @@ }, { "name" : "collect", + "type" : "function", "desc" : "Collects unique values for a particular dataIndex from this store.", + "sig" : "(dataIndex, allowNull, bypassFilter)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "dataIndex", @@ -655,15 +757,20 @@ }, { "name" : "getModifiedRecords", + "type" : "function", "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -675,15 +782,20 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Remove a Record from the Store and fires the remove event.", + "sig" : "(record)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "record", @@ -696,15 +808,20 @@ }, { "name" : "loadData", + "type" : "function", "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.", + "sig" : "(data, append)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "data", @@ -723,15 +840,20 @@ }, { "name" : "load", + "type" : "function", "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n

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

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

", + "sig" : "(options)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "options", @@ -744,15 +866,20 @@ }, { "name" : "setDefaultSort", + "type" : "function", "desc" : "Sets the default sort column and order to be used by the next load operation.", + "sig" : "(fieldName, dir)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fieldName", @@ -771,15 +898,20 @@ }, { "name" : "insert", + "type" : "function", "desc" : "Inserts Records to the Store at the given index and fires the add event.", + "sig" : "(index, records)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -798,43 +930,58 @@ }, { "name" : "getSortState", + "type" : "function", "desc" : "Returns the sort state of the Store as an object with two properties:\n

\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n
", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Store", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -865,15 +1012,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -898,15 +1050,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -919,15 +1076,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -940,15 +1102,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -973,15 +1140,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1006,15 +1178,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1033,15 +1210,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1066,15 +1248,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1107,8 +1294,10 @@ "events" : [ { "name" : "beforeloadadd", + "type" : "function", "desc" : "Fires after a new set of Records has been loaded.", - "memberOf" : "Roo.data.Store", + "sig" : "function (_self, records, options)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1137,8 +1326,10 @@ }, { "name" : "loadexception", + "type" : "function", "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args", - "memberOf" : "Roo.data.Store", + "sig" : "function (, return, load, jsonData)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1173,8 +1364,10 @@ }, { "name" : "load", + "type" : "function", "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.", - "memberOf" : "Roo.data.Store", + "sig" : "function (_self, records, options)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1203,8 +1396,10 @@ }, { "name" : "add", + "type" : "function", "desc" : "Fires when Records have been added to the Store", - "memberOf" : "Roo.data.Store", + "sig" : "function (_self, records, index)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1233,8 +1428,10 @@ }, { "name" : "metachange", + "type" : "function", "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.", - "memberOf" : "Roo.data.Store", + "sig" : "function (_self, meta)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1257,8 +1454,10 @@ }, { "name" : "clear", + "type" : "function", "desc" : "Fires when the data cache has been cleared.", - "memberOf" : "Roo.data.Store", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1275,8 +1474,10 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Fires when a Record has been removed from the Store", - "memberOf" : "Roo.data.Store", + "sig" : "function (_self, record, index)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1305,8 +1506,10 @@ }, { "name" : "update", + "type" : "function", "desc" : "Fires when a Record has been updated", - "memberOf" : "Roo.data.Store", + "sig" : "function (_self, record, operation)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1335,8 +1538,10 @@ }, { "name" : "beforeload", + "type" : "function", "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.", - "memberOf" : "Roo.data.Store", + "sig" : "function (_self, options)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1359,8 +1564,10 @@ }, { "name" : "datachanged", + "type" : "function", "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.", - "memberOf" : "Roo.data.Store", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.data.Tree.json b/docs/symbols/Roo.data.Tree.json index e9522d3308..c54dca4451 100644 --- a/docs/symbols/Roo.data.Tree.json +++ b/docs/symbols/Roo.data.Tree.json @@ -21,27 +21,33 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" } ], "methods" : [ { "name" : "setRootNode", + "type" : "function", "desc" : "Sets the root node for this tree.", + "sig" : "(node)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Tree", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -60,15 +66,20 @@ }, { "name" : "getRootNode", + "type" : "function", "desc" : "Returns the root node for this tree.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Tree", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -80,15 +91,20 @@ }, { "name" : "getNodeById", + "type" : "function", "desc" : "Gets a node in this tree by its id.", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Tree", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -107,29 +123,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -160,15 +186,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -193,15 +224,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -214,15 +250,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -235,15 +276,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -268,15 +314,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -301,15 +352,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -328,15 +384,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -361,15 +422,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -402,8 +468,10 @@ "events" : [ { "name" : "append", + "type" : "function", "desc" : "Fires when a new child node is appended to a node in this tree.", - "memberOf" : "Roo.data.Tree", + "sig" : "function (tree, parent, node, index)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -438,8 +506,10 @@ }, { "name" : "beforemove", + "type" : "function", "desc" : "Fires before a node is moved to a new location in the tree. Return false to cancel the move.", - "memberOf" : "Roo.data.Tree", + "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -480,8 +550,10 @@ }, { "name" : "insert", + "type" : "function", "desc" : "Fires when a new child node is inserted in a node in this tree.", - "memberOf" : "Roo.data.Tree", + "sig" : "function (tree, parent, node, refNode)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -516,8 +588,10 @@ }, { "name" : "beforeappend", + "type" : "function", "desc" : "Fires before a new child is appended to a node in this tree, return false to cancel the append.", - "memberOf" : "Roo.data.Tree", + "sig" : "function (tree, parent, node)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -546,8 +620,10 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires when a node is moved to a new location in the tree", - "memberOf" : "Roo.data.Tree", + "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -588,8 +664,10 @@ }, { "name" : "beforeremove", + "type" : "function", "desc" : "Fires before a child is removed from a node in this tree, return false to cancel the remove.", - "memberOf" : "Roo.data.Tree", + "sig" : "function (tree, parent, node)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -618,8 +696,10 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Fires when a child node is removed from a node in this tree.", - "memberOf" : "Roo.data.Tree", + "sig" : "function (tree, parent, node)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -648,8 +728,10 @@ }, { "name" : "beforeinsert", + "type" : "function", "desc" : "Fires before a new child is inserted in a node in this tree, return false to cancel the insert.", - "memberOf" : "Roo.data.Tree", + "sig" : "function (tree, parent, node, refNode)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.data.XmlReader.json b/docs/symbols/Roo.data.XmlReader.json index 5034e0db15..0ee884514f 100644 --- a/docs/symbols/Roo.data.XmlReader.json +++ b/docs/symbols/Roo.data.XmlReader.json @@ -27,48 +27,51 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "id", "type" : "String", "desc" : "The DomQuery path relative from the record element to the element that contains\na record identifier value.", - "memberOf" : "Roo.data.XmlReader", - "optvals" : [] + "memberOf" : "" }, { "name" : "success", "type" : "String", "desc" : "The DomQuery path to the success attribute used by forms.", - "memberOf" : "Roo.data.XmlReader", - "optvals" : [] + "memberOf" : "" }, { "name" : "record", "type" : "String", "desc" : "The DomQuery path to the repeated element which contains record information.", - "memberOf" : "Roo.data.XmlReader", - "optvals" : [] + "memberOf" : "" }, { "name" : "totalRecords", "type" : "String", "desc" : "The DomQuery path from which to retrieve the total number of records\nin the dataset. This is only needed if the whole dataset is not passed in one go, but is being\npaged from the remote server.", - "memberOf" : "Roo.data.XmlReader", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "read", + "type" : "function", "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.", + "sig" : "(response)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.XmlReader", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "response", @@ -87,15 +90,20 @@ }, { "name" : "readRecords", + "type" : "function", "desc" : "Create a data block containing Roo.data.Records from an XML document.", + "sig" : "(doc)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.XmlReader", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "doc", @@ -114,15 +122,20 @@ }, { "name" : "newRow", + "type" : "function", "desc" : "Create an empty record", + "sig" : "(data)", + "static" : false, + "memberOf" : "Roo.data.DataReader", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.DataReader", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "data", diff --git a/docs/symbols/Roo.data.json b/docs/symbols/Roo.data.json index 3d8ae76137..172313f623 100644 --- a/docs/symbols/Roo.data.json +++ b/docs/symbols/Roo.data.json @@ -12,6 +12,8 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.dd.DD.json b/docs/symbols/Roo.dd.DD.json index 78bc8e96a1..8fdfad9ecf 100644 --- a/docs/symbols/Roo.dd.DD.json +++ b/docs/symbols/Roo.dd.DD.json @@ -34,27 +34,33 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" } ], "methods" : [ { "name" : "alignElWithMouse", + "type" : "function", "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "sig" : "(el, iPageX, iPageY)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -79,15 +85,20 @@ }, { "name" : "setDelta", + "type" : "function", "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)", + "sig" : "(iDeltaX, iDeltaY)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iDeltaX", @@ -106,15 +117,20 @@ }, { "name" : "autoOffset", + "type" : "function", "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iPageX", @@ -133,15 +149,20 @@ }, { "name" : "setDragElPos", + "type" : "function", "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iPageX", @@ -160,15 +181,20 @@ }, { "name" : "cachePosition", + "type" : "function", "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iPageX", @@ -187,15 +213,20 @@ }, { "name" : "setHandleElId", + "type" : "function", "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -208,15 +239,20 @@ }, { "name" : "init", + "type" : "function", "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -241,15 +277,20 @@ }, { "name" : "removeInvalidHandleType", + "type" : "function", "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "tagName", @@ -262,29 +303,39 @@ }, { "name" : "unreg", + "type" : "function", "desc" : "Remove all drag and drop hooks for this element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "addInvalidHandleType", + "type" : "function", "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "tagName", @@ -297,15 +348,20 @@ }, { "name" : "onDragDrop", + "type" : "function", "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -324,15 +380,20 @@ }, { "name" : "removeInvalidHandleId", + "type" : "function", "desc" : "Unsets an invalid handle id", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -345,29 +406,39 @@ }, { "name" : "onAvailable", + "type" : "function", "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setOuterHandleElId", + "type" : "function", "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -380,15 +451,20 @@ }, { "name" : "onMouseUp", + "type" : "function", "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -401,15 +477,20 @@ }, { "name" : "getDragEl", + "type" : "function", "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -421,15 +502,20 @@ }, { "name" : "setYConstraint", + "type" : "function", "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "sig" : "(iUp, iDown, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iUp", @@ -454,29 +540,39 @@ }, { "name" : "clearConstraints", + "type" : "function", "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onInvalidDrop", + "type" : "function", "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -489,15 +585,20 @@ }, { "name" : "addInvalidHandleId", + "type" : "function", "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -510,15 +611,20 @@ }, { "name" : "removeInvalidHandleClass", + "type" : "function", "desc" : "Unsets an invalid css class", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cssClass", @@ -531,15 +637,20 @@ }, { "name" : "onDragOut", + "type" : "function", "desc" : "Abstract method called when we are no longer hovering over an element", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -558,15 +669,20 @@ }, { "name" : "setDragElId", + "type" : "function", "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -579,15 +695,20 @@ }, { "name" : "endDrag", + "type" : "function", "desc" : "Fired when we are done dragging the object", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -600,15 +721,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns a reference to the linked element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -620,15 +746,20 @@ }, { "name" : "onDrag", + "type" : "function", "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -641,15 +772,20 @@ }, { "name" : "onDragEnter", + "type" : "function", "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -668,29 +804,39 @@ }, { "name" : "lock", + "type" : "function", "desc" : "Lock this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onMouseDown", + "type" : "function", "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -703,57 +849,77 @@ }, { "name" : "applyConfig", + "type" : "function", "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "unlock", + "type" : "function", "desc" : "Unlock this instace", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isTarget", + "type" : "function", "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setInitPosition", + "type" : "function", "desc" : "Stores the initial placement of the linked element.", + "sig" : "(diffX, diffY)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "diffX", @@ -772,15 +938,20 @@ }, { "name" : "initTarget", + "type" : "function", "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -805,15 +976,20 @@ }, { "name" : "addToGroup", + "type" : "function", "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sGroup", @@ -826,15 +1002,20 @@ }, { "name" : "onDragOver", + "type" : "function", "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -853,15 +1034,20 @@ }, { "name" : "toString", + "type" : "function", "desc" : "toString method", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -873,15 +1059,20 @@ }, { "name" : "setPadding", + "type" : "function", "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "sig" : "(iTop, iRight, iBot, iLeft)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iTop", @@ -912,15 +1103,20 @@ }, { "name" : "removeFromGroup", + "type" : "function", "desc" : "Remove's this instance from the supplied interaction group", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sGroup", @@ -933,15 +1129,20 @@ }, { "name" : "addInvalidHandleClass", + "type" : "function", "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cssClass", @@ -954,15 +1155,20 @@ }, { "name" : "startDrag", + "type" : "function", "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "sig" : "(X, Y)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "X", @@ -981,29 +1187,39 @@ }, { "name" : "padding", + "type" : "function", "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "resetConstraints", + "type" : "function", "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "sig" : "(maintainOffset)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "maintainOffset", @@ -1016,29 +1232,39 @@ }, { "name" : "clearTicks", + "type" : "function", "desc" : "Clears any tick interval defined for this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isLocked", + "type" : "function", "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1050,15 +1276,20 @@ }, { "name" : "setXConstraint", + "type" : "function", "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "sig" : "(iLeft, iRight, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iLeft", @@ -1083,15 +1314,20 @@ }, { "name" : "isValidHandleChild", + "type" : "function", "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -1110,29 +1346,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1163,15 +1409,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1196,15 +1447,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1217,15 +1473,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1238,15 +1499,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1271,15 +1537,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1304,15 +1575,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1331,15 +1607,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1364,15 +1645,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", diff --git a/docs/symbols/Roo.dd.DDProxy.json b/docs/symbols/Roo.dd.DDProxy.json index f476921f71..e561c48617 100644 --- a/docs/symbols/Roo.dd.DDProxy.json +++ b/docs/symbols/Roo.dd.DDProxy.json @@ -35,55 +35,71 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" } ], "methods" : [ { "name" : "initFrame", + "type" : "function", "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DDProxy", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "createFrame", + "type" : "function", "desc" : "Creates the proxy element if it does not yet exist", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DDProxy", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "alignElWithMouse", + "type" : "function", "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "sig" : "(el, iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -108,15 +124,20 @@ }, { "name" : "setDelta", + "type" : "function", "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)", + "sig" : "(iDeltaX, iDeltaY)", + "static" : false, + "memberOf" : "Roo.dd.DD", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iDeltaX", @@ -135,15 +156,20 @@ }, { "name" : "autoOffset", + "type" : "function", "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iPageX", @@ -162,15 +188,20 @@ }, { "name" : "setDragElPos", + "type" : "function", "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iPageX", @@ -189,15 +220,20 @@ }, { "name" : "cachePosition", + "type" : "function", "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iPageX", @@ -216,15 +252,20 @@ }, { "name" : "setHandleElId", + "type" : "function", "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -237,15 +278,20 @@ }, { "name" : "init", + "type" : "function", "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -270,15 +316,20 @@ }, { "name" : "removeInvalidHandleType", + "type" : "function", "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "tagName", @@ -291,29 +342,39 @@ }, { "name" : "unreg", + "type" : "function", "desc" : "Remove all drag and drop hooks for this element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "addInvalidHandleType", + "type" : "function", "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "tagName", @@ -326,15 +387,20 @@ }, { "name" : "onDragDrop", + "type" : "function", "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -353,15 +419,20 @@ }, { "name" : "removeInvalidHandleId", + "type" : "function", "desc" : "Unsets an invalid handle id", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -374,29 +445,39 @@ }, { "name" : "onAvailable", + "type" : "function", "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setOuterHandleElId", + "type" : "function", "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -409,15 +490,20 @@ }, { "name" : "onMouseUp", + "type" : "function", "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -430,15 +516,20 @@ }, { "name" : "getDragEl", + "type" : "function", "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -450,15 +541,20 @@ }, { "name" : "setYConstraint", + "type" : "function", "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "sig" : "(iUp, iDown, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iUp", @@ -483,29 +579,39 @@ }, { "name" : "clearConstraints", + "type" : "function", "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onInvalidDrop", + "type" : "function", "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -518,15 +624,20 @@ }, { "name" : "addInvalidHandleId", + "type" : "function", "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -539,15 +650,20 @@ }, { "name" : "removeInvalidHandleClass", + "type" : "function", "desc" : "Unsets an invalid css class", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cssClass", @@ -560,15 +676,20 @@ }, { "name" : "onDragOut", + "type" : "function", "desc" : "Abstract method called when we are no longer hovering over an element", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -587,15 +708,20 @@ }, { "name" : "setDragElId", + "type" : "function", "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -608,15 +734,20 @@ }, { "name" : "endDrag", + "type" : "function", "desc" : "Fired when we are done dragging the object", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -629,15 +760,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns a reference to the linked element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -649,15 +785,20 @@ }, { "name" : "onDrag", + "type" : "function", "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -670,15 +811,20 @@ }, { "name" : "onDragEnter", + "type" : "function", "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -697,29 +843,39 @@ }, { "name" : "lock", + "type" : "function", "desc" : "Lock this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onMouseDown", + "type" : "function", "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -732,57 +888,77 @@ }, { "name" : "applyConfig", + "type" : "function", "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "unlock", + "type" : "function", "desc" : "Unlock this instace", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isTarget", + "type" : "function", "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setInitPosition", + "type" : "function", "desc" : "Stores the initial placement of the linked element.", + "sig" : "(diffX, diffY)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "diffX", @@ -801,15 +977,20 @@ }, { "name" : "initTarget", + "type" : "function", "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -834,15 +1015,20 @@ }, { "name" : "addToGroup", + "type" : "function", "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sGroup", @@ -855,15 +1041,20 @@ }, { "name" : "onDragOver", + "type" : "function", "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -882,15 +1073,20 @@ }, { "name" : "toString", + "type" : "function", "desc" : "toString method", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -902,15 +1098,20 @@ }, { "name" : "setPadding", + "type" : "function", "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "sig" : "(iTop, iRight, iBot, iLeft)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iTop", @@ -941,15 +1142,20 @@ }, { "name" : "removeFromGroup", + "type" : "function", "desc" : "Remove's this instance from the supplied interaction group", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sGroup", @@ -962,15 +1168,20 @@ }, { "name" : "addInvalidHandleClass", + "type" : "function", "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cssClass", @@ -983,15 +1194,20 @@ }, { "name" : "startDrag", + "type" : "function", "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "sig" : "(X, Y)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "X", @@ -1010,29 +1226,39 @@ }, { "name" : "padding", + "type" : "function", "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "resetConstraints", + "type" : "function", "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "sig" : "(maintainOffset)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "maintainOffset", @@ -1045,29 +1271,39 @@ }, { "name" : "clearTicks", + "type" : "function", "desc" : "Clears any tick interval defined for this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isLocked", + "type" : "function", "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1079,15 +1315,20 @@ }, { "name" : "setXConstraint", + "type" : "function", "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "sig" : "(iLeft, iRight, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iLeft", @@ -1112,15 +1353,20 @@ }, { "name" : "isValidHandleChild", + "type" : "function", "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -1139,29 +1385,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1192,15 +1448,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1225,15 +1486,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1246,15 +1512,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1267,15 +1538,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1300,15 +1576,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1333,15 +1614,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1360,15 +1646,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1393,15 +1684,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", diff --git a/docs/symbols/Roo.dd.DDTarget.json b/docs/symbols/Roo.dd.DDTarget.json index 296e3f483f..ace1fceeaa 100644 --- a/docs/symbols/Roo.dd.DDTarget.json +++ b/docs/symbols/Roo.dd.DDTarget.json @@ -34,27 +34,33 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" } ], "methods" : [ { "name" : "setHandleElId", + "type" : "function", "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -67,15 +73,20 @@ }, { "name" : "init", + "type" : "function", "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -100,15 +111,20 @@ }, { "name" : "removeInvalidHandleType", + "type" : "function", "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "tagName", @@ -121,29 +137,39 @@ }, { "name" : "unreg", + "type" : "function", "desc" : "Remove all drag and drop hooks for this element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "addInvalidHandleType", + "type" : "function", "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "tagName", @@ -156,15 +182,20 @@ }, { "name" : "onDragDrop", + "type" : "function", "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -183,15 +214,20 @@ }, { "name" : "removeInvalidHandleId", + "type" : "function", "desc" : "Unsets an invalid handle id", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -204,29 +240,39 @@ }, { "name" : "onAvailable", + "type" : "function", "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setOuterHandleElId", + "type" : "function", "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -239,15 +285,20 @@ }, { "name" : "onMouseUp", + "type" : "function", "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -260,15 +311,20 @@ }, { "name" : "getDragEl", + "type" : "function", "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -280,15 +336,20 @@ }, { "name" : "setYConstraint", + "type" : "function", "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "sig" : "(iUp, iDown, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iUp", @@ -313,29 +374,39 @@ }, { "name" : "clearConstraints", + "type" : "function", "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onInvalidDrop", + "type" : "function", "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -348,15 +419,20 @@ }, { "name" : "addInvalidHandleId", + "type" : "function", "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -369,15 +445,20 @@ }, { "name" : "removeInvalidHandleClass", + "type" : "function", "desc" : "Unsets an invalid css class", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cssClass", @@ -390,15 +471,20 @@ }, { "name" : "onDragOut", + "type" : "function", "desc" : "Abstract method called when we are no longer hovering over an element", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -417,15 +503,20 @@ }, { "name" : "setDragElId", + "type" : "function", "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -438,15 +529,20 @@ }, { "name" : "endDrag", + "type" : "function", "desc" : "Fired when we are done dragging the object", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -459,15 +555,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns a reference to the linked element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -479,15 +580,20 @@ }, { "name" : "onDrag", + "type" : "function", "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -500,15 +606,20 @@ }, { "name" : "onDragEnter", + "type" : "function", "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -527,29 +638,39 @@ }, { "name" : "lock", + "type" : "function", "desc" : "Lock this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onMouseDown", + "type" : "function", "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -562,57 +683,77 @@ }, { "name" : "applyConfig", + "type" : "function", "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "unlock", + "type" : "function", "desc" : "Unlock this instace", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isTarget", + "type" : "function", "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setInitPosition", + "type" : "function", "desc" : "Stores the initial placement of the linked element.", + "sig" : "(diffX, diffY)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "diffX", @@ -631,15 +772,20 @@ }, { "name" : "initTarget", + "type" : "function", "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -664,15 +810,20 @@ }, { "name" : "addToGroup", + "type" : "function", "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sGroup", @@ -685,15 +836,20 @@ }, { "name" : "onDragOver", + "type" : "function", "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -712,15 +868,20 @@ }, { "name" : "toString", + "type" : "function", "desc" : "toString method", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -732,15 +893,20 @@ }, { "name" : "setPadding", + "type" : "function", "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "sig" : "(iTop, iRight, iBot, iLeft)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iTop", @@ -771,15 +937,20 @@ }, { "name" : "removeFromGroup", + "type" : "function", "desc" : "Remove's this instance from the supplied interaction group", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sGroup", @@ -792,15 +963,20 @@ }, { "name" : "addInvalidHandleClass", + "type" : "function", "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cssClass", @@ -813,15 +989,20 @@ }, { "name" : "startDrag", + "type" : "function", "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "sig" : "(X, Y)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "X", @@ -840,29 +1021,39 @@ }, { "name" : "padding", + "type" : "function", "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "resetConstraints", + "type" : "function", "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "sig" : "(maintainOffset)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "maintainOffset", @@ -875,29 +1066,39 @@ }, { "name" : "clearTicks", + "type" : "function", "desc" : "Clears any tick interval defined for this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isLocked", + "type" : "function", "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -909,15 +1110,20 @@ }, { "name" : "setXConstraint", + "type" : "function", "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "sig" : "(iLeft, iRight, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iLeft", @@ -942,15 +1148,20 @@ }, { "name" : "isValidHandleChild", + "type" : "function", "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -969,29 +1180,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1022,15 +1243,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1055,15 +1281,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1076,15 +1307,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1097,15 +1333,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1130,15 +1371,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1163,15 +1409,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1190,15 +1441,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1223,15 +1479,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", diff --git a/docs/symbols/Roo.dd.DragDrop.json b/docs/symbols/Roo.dd.DragDrop.json index b523a1f9f3..620a89ede3 100644 --- a/docs/symbols/Roo.dd.DragDrop.json +++ b/docs/symbols/Roo.dd.DragDrop.json @@ -33,27 +33,33 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" } ], "methods" : [ { "name" : "setHandleElId", + "type" : "function", "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -66,15 +72,20 @@ }, { "name" : "init", + "type" : "function", "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -99,15 +110,20 @@ }, { "name" : "removeInvalidHandleType", + "type" : "function", "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "tagName", @@ -120,29 +136,39 @@ }, { "name" : "unreg", + "type" : "function", "desc" : "Remove all drag and drop hooks for this element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "addInvalidHandleType", + "type" : "function", "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "tagName", @@ -155,15 +181,20 @@ }, { "name" : "onDragDrop", + "type" : "function", "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -182,15 +213,20 @@ }, { "name" : "removeInvalidHandleId", + "type" : "function", "desc" : "Unsets an invalid handle id", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -203,29 +239,39 @@ }, { "name" : "onAvailable", + "type" : "function", "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setOuterHandleElId", + "type" : "function", "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -238,15 +284,20 @@ }, { "name" : "onMouseUp", + "type" : "function", "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "sig" : "(e)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -259,15 +310,20 @@ }, { "name" : "getDragEl", + "type" : "function", "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -279,15 +335,20 @@ }, { "name" : "setYConstraint", + "type" : "function", "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "sig" : "(iUp, iDown, iTickSize)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iUp", @@ -312,29 +373,39 @@ }, { "name" : "clearConstraints", + "type" : "function", "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onInvalidDrop", + "type" : "function", "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "sig" : "(e)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -347,15 +418,20 @@ }, { "name" : "addInvalidHandleId", + "type" : "function", "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -368,15 +444,20 @@ }, { "name" : "removeInvalidHandleClass", + "type" : "function", "desc" : "Unsets an invalid css class", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cssClass", @@ -389,15 +470,20 @@ }, { "name" : "onDragOut", + "type" : "function", "desc" : "Abstract method called when we are no longer hovering over an element", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -416,15 +502,20 @@ }, { "name" : "setDragElId", + "type" : "function", "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -437,15 +528,20 @@ }, { "name" : "endDrag", + "type" : "function", "desc" : "Fired when we are done dragging the object", + "sig" : "(e)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -458,15 +554,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns a reference to the linked element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -478,15 +579,20 @@ }, { "name" : "onDrag", + "type" : "function", "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "sig" : "(e)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -499,15 +605,20 @@ }, { "name" : "onDragEnter", + "type" : "function", "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -526,29 +637,39 @@ }, { "name" : "lock", + "type" : "function", "desc" : "Lock this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onMouseDown", + "type" : "function", "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "sig" : "(e)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -561,57 +682,77 @@ }, { "name" : "applyConfig", + "type" : "function", "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "unlock", + "type" : "function", "desc" : "Unlock this instace", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isTarget", + "type" : "function", "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setInitPosition", + "type" : "function", "desc" : "Stores the initial placement of the linked element.", + "sig" : "(diffX, diffY)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "diffX", @@ -630,15 +771,20 @@ }, { "name" : "initTarget", + "type" : "function", "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -663,15 +809,20 @@ }, { "name" : "addToGroup", + "type" : "function", "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sGroup", @@ -684,15 +835,20 @@ }, { "name" : "onDragOver", + "type" : "function", "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -711,15 +867,20 @@ }, { "name" : "toString", + "type" : "function", "desc" : "toString method", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -731,15 +892,20 @@ }, { "name" : "setPadding", + "type" : "function", "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "sig" : "(iTop, iRight, iBot, iLeft)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iTop", @@ -770,15 +936,20 @@ }, { "name" : "removeFromGroup", + "type" : "function", "desc" : "Remove's this instance from the supplied interaction group", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sGroup", @@ -791,15 +962,20 @@ }, { "name" : "addInvalidHandleClass", + "type" : "function", "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cssClass", @@ -812,15 +988,20 @@ }, { "name" : "startDrag", + "type" : "function", "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "sig" : "(X, Y)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "X", @@ -839,29 +1020,39 @@ }, { "name" : "padding", + "type" : "function", "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "resetConstraints", + "type" : "function", "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "sig" : "(maintainOffset)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "maintainOffset", @@ -874,29 +1065,39 @@ }, { "name" : "clearTicks", + "type" : "function", "desc" : "Clears any tick interval defined for this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isLocked", + "type" : "function", "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -908,15 +1109,20 @@ }, { "name" : "setXConstraint", + "type" : "function", "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "sig" : "(iLeft, iRight, iTickSize)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iLeft", @@ -941,15 +1147,20 @@ }, { "name" : "isValidHandleChild", + "type" : "function", "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "sig" : "(node)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -968,29 +1179,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1021,15 +1242,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1054,15 +1280,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1075,15 +1306,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1096,15 +1332,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1129,15 +1370,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1162,15 +1408,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1189,15 +1440,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1222,15 +1478,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", diff --git a/docs/symbols/Roo.dd.DragDropMgr.json b/docs/symbols/Roo.dd.DragDropMgr.json index 7b9338a9c7..08a29c3743 100644 --- a/docs/symbols/Roo.dd.DragDropMgr.json +++ b/docs/symbols/Roo.dd.DragDropMgr.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "isDragDrop", + "type" : "function", "desc" : "Utility function to determine if a given element has been\nregistered as a drag drop item.", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -43,15 +50,20 @@ }, { "name" : "getRelated", + "type" : "function", "desc" : "Returns the drag and drop instances that are in all groups the\npassed in instance belongs to.", + "sig" : "(p_oDD, bTargetsOnly)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "p_oDD", @@ -76,15 +88,20 @@ }, { "name" : "getScrollLeft", + "type" : "function", "desc" : "Gets the scrollLeft", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -96,15 +113,20 @@ }, { "name" : "regDragDrop", + "type" : "function", "desc" : "Each DragDrop instance must be registered with the DragDropMgr.\nThis is executed in DragDrop.init()", + "sig" : "(oDD, sGroup)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "oDD", @@ -123,15 +145,20 @@ }, { "name" : "handleWasClicked", + "type" : "function", "desc" : "Recursively searches the immediate parent and all child nodes for\nthe handle element in order to determine wheter or not it was\nclicked.", + "sig" : "(node)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -144,15 +171,20 @@ }, { "name" : "refreshCache", + "type" : "function", "desc" : "Refreshes the cache of the top-left and bottom-right points of the\ndrag and drop objects in the specified group(s). This is in the\nformat that is stored in the drag and drop instance, so typical\nusage is:\n\nRoo.dd.DragDropMgr.refreshCache(ddinstance.groups);\n\nAlternatively:\n\nRoo.dd.DragDropMgr.refreshCache({group1:true, group2:true});\n", + "sig" : "(groups)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "groups", @@ -165,15 +197,20 @@ }, { "name" : "getCss", + "type" : "function", "desc" : "Returns the style property for the DOM element (i.e.,\ndocument.getElById(id).style)", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "This has been deprecated: use Roo.getDom instead", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -192,15 +229,20 @@ }, { "name" : "swapNode", + "type" : "function", "desc" : "Swap two nodes. In IE, we use the native method, for others we\nemulate the IE behavior", + "sig" : "(n1, n2)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "n1", @@ -219,15 +261,20 @@ }, { "name" : "stopEvent", + "type" : "function", "desc" : "Utility to stop event propagation and event default, if these\nfeatures are turned on.", + "sig" : "(e)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -240,29 +287,39 @@ }, { "name" : "lock", + "type" : "function", "desc" : "Lock all drag and drop functionality", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "moveToEl", + "type" : "function", "desc" : "Sets the x/y position of an element to the location of the\ntarget element.", + "sig" : "(moveEl, targetEl)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "moveEl", @@ -281,29 +338,39 @@ }, { "name" : "unlock", + "type" : "function", "desc" : "Unlock all drag and drop functionality", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getDDById", + "type" : "function", "desc" : "Returns the DragDrop instance for a given id", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -322,15 +389,20 @@ }, { "name" : "isLegalTarget", + "type" : "function", "desc" : "Returns true if the specified dd target is a legal target for\nthe specifice drag obj", + "sig" : "(the, the)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -355,15 +427,20 @@ }, { "name" : "isTypeOfDD", + "type" : "function", "desc" : "My goal is to be able to transparently determine if an object is\ntypeof DragDrop, and the exact subclass of DragDrop. typeof\nreturns \"object\", oDD.constructor.toString() always returns\n\"DragDrop\" and not the name of the subclass. So for now it just\nevaluates a well-known variable in DragDrop.", + "sig" : "(the)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "the", @@ -382,15 +459,20 @@ }, { "name" : "startDrag", + "type" : "function", "desc" : "Fired when either the drag pixel threshol or the mousedown hold\ntime threshold has been met.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -409,15 +491,20 @@ }, { "name" : "getStyle", + "type" : "function", "desc" : "Returns the specified element style property", + "sig" : "(el, styleProp)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "This has been deprecated: use Roo.lib.Dom.getStyle", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -442,15 +529,20 @@ }, { "name" : "getPosX", + "type" : "function", "desc" : "Returns the X position of an html element", + "sig" : "(el)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "This has been deprecated: use Roo.lib.Dom.getX instead", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -469,15 +561,20 @@ }, { "name" : "getPosY", + "type" : "function", "desc" : "Returns the Y position of an html element", + "sig" : "(el)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "This has been deprecated: use Roo.lib.Dom.getY instead", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -496,15 +593,20 @@ }, { "name" : "isLocked", + "type" : "function", "desc" : "Is drag and drop locked?", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -516,15 +618,20 @@ }, { "name" : "getBestMatch", + "type" : "function", "desc" : "Helper function for getting the best match from the list of drag\nand drop objects returned by the drag and drop events when we are\nin INTERSECT mode. It returns either the first object that the\ncursor is over, or the object that has the greatest overlap with\nthe dragged element.", + "sig" : "(dds)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "dds", @@ -543,15 +650,20 @@ }, { "name" : "getLocation", + "type" : "function", "desc" : "Returns a Region object containing the drag and drop element's position\nand size, including the padding configured for it", + "sig" : "(oDD)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "oDD", @@ -570,15 +682,20 @@ }, { "name" : "isHandle", + "type" : "function", "desc" : "Utility function to determine if a given element has been\nregistered as a drag drop handle for the given Drag Drop object.", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -597,15 +714,20 @@ }, { "name" : "getScrollTop", + "type" : "function", "desc" : "Gets the scrollTop", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -617,29 +739,39 @@ }, { "name" : "numericSort", + "type" : "function", "desc" : "Numeric array sort function", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "regHandle", + "type" : "function", "desc" : "Each DragDrop handle element must be registered. This is done\nautomatically when executing DragDrop.setHandleElId()", + "sig" : "(sDDId, sHandleId)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sDDId", @@ -658,15 +790,20 @@ }, { "name" : "getElement", + "type" : "function", "desc" : "Returns the actual DOM element", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "This has been deprecated: use Roo.getDom instead", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -685,15 +822,20 @@ }, { "name" : "verifyEl", + "type" : "function", "desc" : "This checks to make sure an element exists and is in the DOM. The\nmain purpose is to handle cases where innerHTML is used to remove\ndrag and drop objects from the DOM. IE provides an 'unspecified\nerror' when trying to access the offsetParent of such an element", + "sig" : "(el)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDropMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", diff --git a/docs/symbols/Roo.dd.DragSource.json b/docs/symbols/Roo.dd.DragSource.json index b680efeea8..0022f4f481 100644 --- a/docs/symbols/Roo.dd.DragSource.json +++ b/docs/symbols/Roo.dd.DragSource.json @@ -30,41 +30,45 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "dropNotAllowed", "type" : "String", "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").", - "memberOf" : "Roo.dd.DragSource", - "optvals" : [] + "memberOf" : "" }, { "name" : "dropAllowed", "type" : "String", "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").", - "memberOf" : "Roo.dd.DragSource", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "beforeDragEnter", + "type" : "function", "desc" : "An empty function by default, but provided so that you can perform a custom action\nbefore the dragged item enters the drop target and optionally cancel the onDragEnter.", + "sig" : "(target, e, id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragSource", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -95,15 +99,20 @@ }, { "name" : "getDragData", + "type" : "function", "desc" : "Returns the data object associated with this drag source", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragSource", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -115,29 +124,39 @@ }, { "name" : "hideProxy", + "type" : "function", "desc" : "Hides the drag source's {@link Roo.dd.StatusProxy}", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragSource", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "beforeDragOut", + "type" : "function", "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dragged out of the target without dropping, and optionally cancel the onDragOut.", + "sig" : "(target, e, id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragSource", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -168,15 +187,20 @@ }, { "name" : "beforeInvalidDrop", + "type" : "function", "desc" : "An empty function by default, but provided so that you can perform a custom action after an invalid\ndrop has occurred.", + "sig" : "(target, e, id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragSource", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -207,15 +231,20 @@ }, { "name" : "beforeDragDrop", + "type" : "function", "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dropped onto the target and optionally cancel the onDragDrop.", + "sig" : "(target, e, id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragSource", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -246,15 +275,20 @@ }, { "name" : "getProxy", + "type" : "function", "desc" : "Returns the drag source's underlying {@link Roo.dd.StatusProxy}", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragSource", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -266,15 +300,20 @@ }, { "name" : "onBeforeDrag", + "type" : "function", "desc" : "An empty function by default, but provided so that you can perform a custom action before the initial\ndrag event begins and optionally cancel it.", + "sig" : "(data, e)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragSource", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "data", @@ -299,15 +338,20 @@ }, { "name" : "onStartDrag", + "type" : "function", "desc" : "An empty function by default, but provided so that you can perform a custom action once the initial\ndrag event has begun. The drag cannot be canceled from this function.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragSource", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -326,15 +370,20 @@ }, { "name" : "beforeDragOver", + "type" : "function", "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target and optionally cancel the onDragOver.", + "sig" : "(target, e, id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragSource", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -365,43 +414,58 @@ }, { "name" : "initFrame", + "type" : "function", "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DDProxy", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DDProxy", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "createFrame", + "type" : "function", "desc" : "Creates the proxy element if it does not yet exist", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DDProxy", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DDProxy", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "alignElWithMouse", + "type" : "function", "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "sig" : "(el, iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -426,15 +490,20 @@ }, { "name" : "setDelta", + "type" : "function", "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)", + "sig" : "(iDeltaX, iDeltaY)", + "static" : false, + "memberOf" : "Roo.dd.DD", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iDeltaX", @@ -453,15 +522,20 @@ }, { "name" : "autoOffset", + "type" : "function", "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iPageX", @@ -480,15 +554,20 @@ }, { "name" : "setDragElPos", + "type" : "function", "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iPageX", @@ -507,15 +586,20 @@ }, { "name" : "cachePosition", + "type" : "function", "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iPageX", @@ -534,15 +618,20 @@ }, { "name" : "setHandleElId", + "type" : "function", "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -555,15 +644,20 @@ }, { "name" : "init", + "type" : "function", "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -588,15 +682,20 @@ }, { "name" : "removeInvalidHandleType", + "type" : "function", "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "tagName", @@ -609,29 +708,39 @@ }, { "name" : "unreg", + "type" : "function", "desc" : "Remove all drag and drop hooks for this element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "addInvalidHandleType", + "type" : "function", "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "tagName", @@ -644,15 +753,20 @@ }, { "name" : "onDragDrop", + "type" : "function", "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -671,15 +785,20 @@ }, { "name" : "removeInvalidHandleId", + "type" : "function", "desc" : "Unsets an invalid handle id", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -692,29 +811,39 @@ }, { "name" : "onAvailable", + "type" : "function", "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setOuterHandleElId", + "type" : "function", "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -727,15 +856,20 @@ }, { "name" : "onMouseUp", + "type" : "function", "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -748,15 +882,20 @@ }, { "name" : "getDragEl", + "type" : "function", "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -768,15 +907,20 @@ }, { "name" : "setYConstraint", + "type" : "function", "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "sig" : "(iUp, iDown, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iUp", @@ -801,29 +945,39 @@ }, { "name" : "clearConstraints", + "type" : "function", "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onInvalidDrop", + "type" : "function", "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -836,15 +990,20 @@ }, { "name" : "addInvalidHandleId", + "type" : "function", "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -857,15 +1016,20 @@ }, { "name" : "removeInvalidHandleClass", + "type" : "function", "desc" : "Unsets an invalid css class", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cssClass", @@ -878,15 +1042,20 @@ }, { "name" : "onDragOut", + "type" : "function", "desc" : "Abstract method called when we are no longer hovering over an element", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -905,15 +1074,20 @@ }, { "name" : "setDragElId", + "type" : "function", "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -926,15 +1100,20 @@ }, { "name" : "endDrag", + "type" : "function", "desc" : "Fired when we are done dragging the object", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -947,15 +1126,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns a reference to the linked element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -967,15 +1151,20 @@ }, { "name" : "onDrag", + "type" : "function", "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -988,15 +1177,20 @@ }, { "name" : "onDragEnter", + "type" : "function", "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -1015,29 +1209,39 @@ }, { "name" : "lock", + "type" : "function", "desc" : "Lock this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onMouseDown", + "type" : "function", "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -1050,57 +1254,77 @@ }, { "name" : "applyConfig", + "type" : "function", "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "unlock", + "type" : "function", "desc" : "Unlock this instace", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isTarget", + "type" : "function", "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setInitPosition", + "type" : "function", "desc" : "Stores the initial placement of the linked element.", + "sig" : "(diffX, diffY)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "diffX", @@ -1119,15 +1343,20 @@ }, { "name" : "initTarget", + "type" : "function", "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -1152,15 +1381,20 @@ }, { "name" : "addToGroup", + "type" : "function", "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sGroup", @@ -1173,15 +1407,20 @@ }, { "name" : "onDragOver", + "type" : "function", "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -1200,15 +1439,20 @@ }, { "name" : "toString", + "type" : "function", "desc" : "toString method", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1220,15 +1464,20 @@ }, { "name" : "setPadding", + "type" : "function", "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "sig" : "(iTop, iRight, iBot, iLeft)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iTop", @@ -1259,15 +1508,20 @@ }, { "name" : "removeFromGroup", + "type" : "function", "desc" : "Remove's this instance from the supplied interaction group", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sGroup", @@ -1280,15 +1534,20 @@ }, { "name" : "addInvalidHandleClass", + "type" : "function", "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cssClass", @@ -1301,15 +1560,20 @@ }, { "name" : "startDrag", + "type" : "function", "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "sig" : "(X, Y)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "X", @@ -1328,29 +1592,39 @@ }, { "name" : "padding", + "type" : "function", "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "resetConstraints", + "type" : "function", "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "sig" : "(maintainOffset)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "maintainOffset", @@ -1363,29 +1637,39 @@ }, { "name" : "clearTicks", + "type" : "function", "desc" : "Clears any tick interval defined for this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isLocked", + "type" : "function", "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1397,15 +1681,20 @@ }, { "name" : "setXConstraint", + "type" : "function", "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "sig" : "(iLeft, iRight, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iLeft", @@ -1430,15 +1719,20 @@ }, { "name" : "isValidHandleChild", + "type" : "function", "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -1457,29 +1751,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1510,15 +1814,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1543,15 +1852,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1564,15 +1878,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1585,15 +1904,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1618,15 +1942,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1651,15 +1980,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1678,15 +2012,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1711,15 +2050,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", diff --git a/docs/symbols/Roo.dd.DragZone.json b/docs/symbols/Roo.dd.DragZone.json index fa27e76ac4..e64fd90602 100644 --- a/docs/symbols/Roo.dd.DragZone.json +++ b/docs/symbols/Roo.dd.DragZone.json @@ -31,55 +31,57 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "dropNotAllowed", "type" : "String", "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").", - "memberOf" : "Roo.dd.DragSource", - "optvals" : [] + "memberOf" : "Roo.dd.DragSource" }, { "name" : "hlColor", "type" : "String", "desc" : "The color to use when visually highlighting the drag source in the afterRepair\nmethod after a failed drop (defaults to \"c3daf9\" - light blue)", - "memberOf" : "Roo.dd.DragZone", - "optvals" : [] + "memberOf" : "" }, { "name" : "dropAllowed", "type" : "String", "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").", - "memberOf" : "Roo.dd.DragSource", - "optvals" : [] + "memberOf" : "Roo.dd.DragSource" }, { "name" : "containerScroll", "type" : "Boolean", "desc" : "True to register this container with the Scrollmanager\nfor auto scrolling during drag operations.", - "memberOf" : "Roo.dd.DragZone", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "getRepairXY", + "type" : "function", "desc" : "Called before a repair of an invalid drop to get the XY to animate to. By default returns\nthe XY of this.dragData.ddel", + "sig" : "(e)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragZone", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -98,29 +100,39 @@ }, { "name" : "afterRepair", + "type" : "function", "desc" : "Called after a repair of an invalid drop. By default, highlights this.dragData.ddel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragZone", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getDragData", + "type" : "function", "desc" : "Called when a mousedown occurs in this container. Looks in {@link Roo.dd.Registry}\nfor a valid target to drag based on the mouse down. Override this method\nto provide your own lookup logic (e.g. finding a child by class name). Make sure your returned\nobject has a \"ddel\" attribute (with an HTML Element) for other functions to work.", + "sig" : "(e)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragZone", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -139,15 +151,20 @@ }, { "name" : "onInitDrag", + "type" : "function", "desc" : "Called once drag threshold has been reached to initialize the proxy element. By default, it clones the\nthis.dragData.ddel", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragZone", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -172,15 +189,20 @@ }, { "name" : "beforeDragEnter", + "type" : "function", "desc" : "An empty function by default, but provided so that you can perform a custom action\nbefore the dragged item enters the drop target and optionally cancel the onDragEnter.", + "sig" : "(target, e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragSource", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragSource", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -211,29 +233,39 @@ }, { "name" : "hideProxy", + "type" : "function", "desc" : "Hides the drag source's {@link Roo.dd.StatusProxy}", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragSource", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragSource", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "beforeDragOut", + "type" : "function", "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dragged out of the target without dropping, and optionally cancel the onDragOut.", + "sig" : "(target, e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragSource", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragSource", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -264,15 +296,20 @@ }, { "name" : "beforeInvalidDrop", + "type" : "function", "desc" : "An empty function by default, but provided so that you can perform a custom action after an invalid\ndrop has occurred.", + "sig" : "(target, e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragSource", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragSource", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -303,15 +340,20 @@ }, { "name" : "beforeDragDrop", + "type" : "function", "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dropped onto the target and optionally cancel the onDragDrop.", + "sig" : "(target, e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragSource", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragSource", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -342,15 +384,20 @@ }, { "name" : "getProxy", + "type" : "function", "desc" : "Returns the drag source's underlying {@link Roo.dd.StatusProxy}", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragSource", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragSource", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -362,15 +409,20 @@ }, { "name" : "onBeforeDrag", + "type" : "function", "desc" : "An empty function by default, but provided so that you can perform a custom action before the initial\ndrag event begins and optionally cancel it.", + "sig" : "(data, e)", + "static" : false, + "memberOf" : "Roo.dd.DragSource", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragSource", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "data", @@ -395,15 +447,20 @@ }, { "name" : "onStartDrag", + "type" : "function", "desc" : "An empty function by default, but provided so that you can perform a custom action once the initial\ndrag event has begun. The drag cannot be canceled from this function.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.dd.DragSource", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragSource", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -422,15 +479,20 @@ }, { "name" : "beforeDragOver", + "type" : "function", "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target and optionally cancel the onDragOver.", + "sig" : "(target, e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragSource", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragSource", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "target", @@ -461,43 +523,58 @@ }, { "name" : "initFrame", + "type" : "function", "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DDProxy", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DDProxy", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "createFrame", + "type" : "function", "desc" : "Creates the proxy element if it does not yet exist", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DDProxy", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DDProxy", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "alignElWithMouse", + "type" : "function", "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "sig" : "(el, iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -522,15 +599,20 @@ }, { "name" : "setDelta", + "type" : "function", "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)", + "sig" : "(iDeltaX, iDeltaY)", + "static" : false, + "memberOf" : "Roo.dd.DD", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iDeltaX", @@ -549,15 +631,20 @@ }, { "name" : "autoOffset", + "type" : "function", "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iPageX", @@ -576,15 +663,20 @@ }, { "name" : "setDragElPos", + "type" : "function", "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iPageX", @@ -603,15 +695,20 @@ }, { "name" : "cachePosition", + "type" : "function", "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iPageX", @@ -630,15 +727,20 @@ }, { "name" : "setHandleElId", + "type" : "function", "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -651,15 +753,20 @@ }, { "name" : "init", + "type" : "function", "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -684,15 +791,20 @@ }, { "name" : "removeInvalidHandleType", + "type" : "function", "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "tagName", @@ -705,29 +817,39 @@ }, { "name" : "unreg", + "type" : "function", "desc" : "Remove all drag and drop hooks for this element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "addInvalidHandleType", + "type" : "function", "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "tagName", @@ -740,15 +862,20 @@ }, { "name" : "onDragDrop", + "type" : "function", "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -767,15 +894,20 @@ }, { "name" : "removeInvalidHandleId", + "type" : "function", "desc" : "Unsets an invalid handle id", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -788,29 +920,39 @@ }, { "name" : "onAvailable", + "type" : "function", "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setOuterHandleElId", + "type" : "function", "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -823,15 +965,20 @@ }, { "name" : "onMouseUp", + "type" : "function", "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -844,15 +991,20 @@ }, { "name" : "getDragEl", + "type" : "function", "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -864,15 +1016,20 @@ }, { "name" : "setYConstraint", + "type" : "function", "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "sig" : "(iUp, iDown, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iUp", @@ -897,29 +1054,39 @@ }, { "name" : "clearConstraints", + "type" : "function", "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onInvalidDrop", + "type" : "function", "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -932,15 +1099,20 @@ }, { "name" : "addInvalidHandleId", + "type" : "function", "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -953,15 +1125,20 @@ }, { "name" : "removeInvalidHandleClass", + "type" : "function", "desc" : "Unsets an invalid css class", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cssClass", @@ -974,15 +1151,20 @@ }, { "name" : "onDragOut", + "type" : "function", "desc" : "Abstract method called when we are no longer hovering over an element", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -1001,15 +1183,20 @@ }, { "name" : "setDragElId", + "type" : "function", "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -1022,15 +1209,20 @@ }, { "name" : "endDrag", + "type" : "function", "desc" : "Fired when we are done dragging the object", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -1043,15 +1235,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns a reference to the linked element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1063,15 +1260,20 @@ }, { "name" : "onDrag", + "type" : "function", "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -1084,15 +1286,20 @@ }, { "name" : "onDragEnter", + "type" : "function", "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -1111,29 +1318,39 @@ }, { "name" : "lock", + "type" : "function", "desc" : "Lock this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onMouseDown", + "type" : "function", "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -1146,57 +1363,77 @@ }, { "name" : "applyConfig", + "type" : "function", "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "unlock", + "type" : "function", "desc" : "Unlock this instace", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isTarget", + "type" : "function", "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setInitPosition", + "type" : "function", "desc" : "Stores the initial placement of the linked element.", + "sig" : "(diffX, diffY)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "diffX", @@ -1215,15 +1452,20 @@ }, { "name" : "initTarget", + "type" : "function", "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -1248,15 +1490,20 @@ }, { "name" : "addToGroup", + "type" : "function", "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sGroup", @@ -1269,15 +1516,20 @@ }, { "name" : "onDragOver", + "type" : "function", "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -1296,15 +1548,20 @@ }, { "name" : "toString", + "type" : "function", "desc" : "toString method", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1316,15 +1573,20 @@ }, { "name" : "setPadding", + "type" : "function", "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "sig" : "(iTop, iRight, iBot, iLeft)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iTop", @@ -1355,15 +1617,20 @@ }, { "name" : "removeFromGroup", + "type" : "function", "desc" : "Remove's this instance from the supplied interaction group", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sGroup", @@ -1376,15 +1643,20 @@ }, { "name" : "addInvalidHandleClass", + "type" : "function", "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cssClass", @@ -1397,15 +1669,20 @@ }, { "name" : "startDrag", + "type" : "function", "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "sig" : "(X, Y)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "X", @@ -1424,29 +1701,39 @@ }, { "name" : "padding", + "type" : "function", "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "resetConstraints", + "type" : "function", "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "sig" : "(maintainOffset)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "maintainOffset", @@ -1459,29 +1746,39 @@ }, { "name" : "clearTicks", + "type" : "function", "desc" : "Clears any tick interval defined for this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isLocked", + "type" : "function", "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1493,15 +1790,20 @@ }, { "name" : "setXConstraint", + "type" : "function", "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "sig" : "(iLeft, iRight, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iLeft", @@ -1526,15 +1828,20 @@ }, { "name" : "isValidHandleChild", + "type" : "function", "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -1553,29 +1860,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1606,15 +1923,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1639,15 +1961,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1660,15 +1987,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1681,15 +2013,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1714,15 +2051,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1747,15 +2089,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1774,15 +2121,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1807,15 +2159,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", diff --git a/docs/symbols/Roo.dd.DropTarget.json b/docs/symbols/Roo.dd.DropTarget.json index 50c82b01ab..1bced557f7 100644 --- a/docs/symbols/Roo.dd.DropTarget.json +++ b/docs/symbols/Roo.dd.DropTarget.json @@ -29,125 +29,145 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "dropNotAllowed", "type" : "String", "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").", - "memberOf" : "Roo.dd.DropTarget", - "optvals" : [] + "memberOf" : "" }, { "name" : "valid", "type" : "boolean|String", "desc" : "true/false or string (ok-add/ok-sub/ok/nodrop)\nif the drop point is valid for over/enter..", - "memberOf" : "Roo.dd.DropTarget", - "optvals" : [] + "memberOf" : "" }, { "name" : "success", "type" : "boolean", "desc" : "set this after drop listener..", - "memberOf" : "Roo.dd.DropTarget", - "optvals" : [] + "memberOf" : "" }, { "name" : "dropAllowed", "type" : "String", "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").", - "memberOf" : "Roo.dd.DropTarget", - "optvals" : [] + "memberOf" : "" }, { "name" : "overClass", "type" : "String", "desc" : "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").", - "memberOf" : "Roo.dd.DropTarget", - "optvals" : [] + "memberOf" : "" }, { "name" : "ddGroup", "type" : "String", "desc" : "The drag drop group to handle drop events for", - "memberOf" : "Roo.dd.DropTarget", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "notifyDrop", + "type" : "function", "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DropTarget", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "notifyEnter", + "type" : "function", "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DropTarget", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "notifyOut", + "type" : "function", "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DropTarget", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "notifyOver", + "type" : "function", "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DropTarget", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setHandleElId", + "type" : "function", "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -160,15 +180,20 @@ }, { "name" : "init", + "type" : "function", "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -193,15 +218,20 @@ }, { "name" : "removeInvalidHandleType", + "type" : "function", "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "tagName", @@ -214,29 +244,39 @@ }, { "name" : "unreg", + "type" : "function", "desc" : "Remove all drag and drop hooks for this element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "addInvalidHandleType", + "type" : "function", "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "tagName", @@ -249,15 +289,20 @@ }, { "name" : "onDragDrop", + "type" : "function", "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -276,15 +321,20 @@ }, { "name" : "removeInvalidHandleId", + "type" : "function", "desc" : "Unsets an invalid handle id", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -297,29 +347,39 @@ }, { "name" : "onAvailable", + "type" : "function", "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setOuterHandleElId", + "type" : "function", "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -332,15 +392,20 @@ }, { "name" : "onMouseUp", + "type" : "function", "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -353,15 +418,20 @@ }, { "name" : "getDragEl", + "type" : "function", "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -373,15 +443,20 @@ }, { "name" : "setYConstraint", + "type" : "function", "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "sig" : "(iUp, iDown, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iUp", @@ -406,29 +481,39 @@ }, { "name" : "clearConstraints", + "type" : "function", "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onInvalidDrop", + "type" : "function", "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -441,15 +526,20 @@ }, { "name" : "addInvalidHandleId", + "type" : "function", "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -462,15 +552,20 @@ }, { "name" : "removeInvalidHandleClass", + "type" : "function", "desc" : "Unsets an invalid css class", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cssClass", @@ -483,15 +578,20 @@ }, { "name" : "onDragOut", + "type" : "function", "desc" : "Abstract method called when we are no longer hovering over an element", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -510,15 +610,20 @@ }, { "name" : "setDragElId", + "type" : "function", "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -531,15 +636,20 @@ }, { "name" : "endDrag", + "type" : "function", "desc" : "Fired when we are done dragging the object", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -552,15 +662,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns a reference to the linked element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -572,15 +687,20 @@ }, { "name" : "onDrag", + "type" : "function", "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -593,15 +713,20 @@ }, { "name" : "onDragEnter", + "type" : "function", "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -620,29 +745,39 @@ }, { "name" : "lock", + "type" : "function", "desc" : "Lock this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onMouseDown", + "type" : "function", "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -655,57 +790,77 @@ }, { "name" : "applyConfig", + "type" : "function", "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "unlock", + "type" : "function", "desc" : "Unlock this instace", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isTarget", + "type" : "function", "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setInitPosition", + "type" : "function", "desc" : "Stores the initial placement of the linked element.", + "sig" : "(diffX, diffY)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "diffX", @@ -724,15 +879,20 @@ }, { "name" : "initTarget", + "type" : "function", "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -757,15 +917,20 @@ }, { "name" : "addToGroup", + "type" : "function", "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sGroup", @@ -778,15 +943,20 @@ }, { "name" : "onDragOver", + "type" : "function", "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -805,15 +975,20 @@ }, { "name" : "toString", + "type" : "function", "desc" : "toString method", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -825,15 +1000,20 @@ }, { "name" : "setPadding", + "type" : "function", "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "sig" : "(iTop, iRight, iBot, iLeft)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iTop", @@ -864,15 +1044,20 @@ }, { "name" : "removeFromGroup", + "type" : "function", "desc" : "Remove's this instance from the supplied interaction group", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sGroup", @@ -885,15 +1070,20 @@ }, { "name" : "addInvalidHandleClass", + "type" : "function", "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cssClass", @@ -906,15 +1096,20 @@ }, { "name" : "startDrag", + "type" : "function", "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "sig" : "(X, Y)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "X", @@ -933,29 +1128,39 @@ }, { "name" : "padding", + "type" : "function", "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "resetConstraints", + "type" : "function", "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "sig" : "(maintainOffset)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "maintainOffset", @@ -968,29 +1173,39 @@ }, { "name" : "clearTicks", + "type" : "function", "desc" : "Clears any tick interval defined for this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isLocked", + "type" : "function", "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1002,15 +1217,20 @@ }, { "name" : "setXConstraint", + "type" : "function", "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "sig" : "(iLeft, iRight, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iLeft", @@ -1035,15 +1255,20 @@ }, { "name" : "isValidHandleChild", + "type" : "function", "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -1062,29 +1287,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1115,15 +1350,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1148,15 +1388,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1169,15 +1414,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1190,15 +1440,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1223,15 +1478,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1256,15 +1516,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1283,15 +1548,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1316,15 +1586,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1357,8 +1632,10 @@ "events" : [ { "name" : "out", + "type" : "function", "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged\nout of the target without dropping. This default implementation simply removes the CSS class specified by\noverClass (if any) from the drop element.", - "memberOf" : "Roo.dd.DropTarget", + "sig" : "function (source, e, data)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1387,8 +1664,10 @@ }, { "name" : "over", + "type" : "function", "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.valid to true|false", - "memberOf" : "Roo.dd.DropTarget", + "sig" : "function (source, e, data)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1417,8 +1696,10 @@ }, { "name" : "enter", + "type" : "function", "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.valid to true|false", - "memberOf" : "Roo.dd.DropTarget", + "sig" : "function (source, e, data)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1447,8 +1728,10 @@ }, { "name" : "drop", + "type" : "function", "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has\nbeen dropped on it. This method has no default implementation and returns false, so you must provide an\nimplementation that does something to process the drop event and returns true so that the drag source's\nrepair action does not run.\n\nIMPORTANT : it should set this.success", - "memberOf" : "Roo.dd.DropTarget", + "sig" : "function (source, e, data)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.dd.DropZone.json b/docs/symbols/Roo.dd.DropZone.json index 517eae343b..e3dbc16759 100644 --- a/docs/symbols/Roo.dd.DropZone.json +++ b/docs/symbols/Roo.dd.DropZone.json @@ -30,69 +30,69 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "dropNotAllowed", "type" : "String", "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").", - "memberOf" : "Roo.dd.DropTarget", - "optvals" : [] + "memberOf" : "Roo.dd.DropTarget" }, { "name" : "valid", "type" : "boolean|String", "desc" : "true/false or string (ok-add/ok-sub/ok/nodrop)\nif the drop point is valid for over/enter..", - "memberOf" : "Roo.dd.DropTarget", - "optvals" : [] + "memberOf" : "Roo.dd.DropTarget" }, { "name" : "success", "type" : "boolean", "desc" : "set this after drop listener..", - "memberOf" : "Roo.dd.DropTarget", - "optvals" : [] + "memberOf" : "Roo.dd.DropTarget" }, { "name" : "dropAllowed", "type" : "String", "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").", - "memberOf" : "Roo.dd.DropTarget", - "optvals" : [] + "memberOf" : "Roo.dd.DropTarget" }, { "name" : "overClass", "type" : "String", "desc" : "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").", - "memberOf" : "Roo.dd.DropTarget", - "optvals" : [] + "memberOf" : "Roo.dd.DropTarget" }, { "name" : "ddGroup", "type" : "String", "desc" : "The drag drop group to handle drop events for", - "memberOf" : "Roo.dd.DropTarget", - "optvals" : [] + "memberOf" : "Roo.dd.DropTarget" } ], "methods" : [ { "name" : "onNodeEnter", + "type" : "function", "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has entered a drop node\nthat it has registered. This method has no default implementation and should be overridden to provide\nnode-specific processing if necessary.", + "sig" : "(nodeData, source, e, data)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DropZone", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "nodeData", @@ -123,15 +123,20 @@ }, { "name" : "onContainerDrop", + "type" : "function", "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped on it,\nbut not on any of its registered drop nodes. The default implementation returns false, so it should be\noverridden to provide the appropriate processing of the drop event if you need the drop zone itself to\nbe able to accept drops. It should return true when valid so that the drag source's repair action does not run.", + "sig" : "(source, e, data)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DropZone", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "source", @@ -162,15 +167,20 @@ }, { "name" : "notifyOver", + "type" : "function", "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the drop zone.\nThis method will be called on every mouse movement while the drag source is over the drop zone.\nIt will call {@link #onNodeOver} while the drag source is over a registered node, and will also automatically\ndelegate to the appropriate node-specific methods as necessary when the drag source enters and exits\nregistered nodes ({@link #onNodeEnter}, {@link #onNodeOut}). If the drag source is not currently over a\nregistered node, it will call {@link #onContainerOver}.", + "sig" : "(source, e, data)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DropZone", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "source", @@ -201,15 +211,20 @@ }, { "name" : "onNodeDrop", + "type" : "function", "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped onto\nthe drop node. The default implementation returns false, so it should be overridden to provide the\nappropriate processing of the drop event and return true so that the drag source's repair action does not run.", + "sig" : "(nodeData, source, e, data)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DropZone", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "nodeData", @@ -246,15 +261,20 @@ }, { "name" : "notifyOut", + "type" : "function", "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source has been dragged\nout of the zone without dropping. If the drag source is currently over a registered node, the notification\nwill be delegated to {@link #onNodeOut} for node-specific handling, otherwise it will be ignored.", + "sig" : "(source, e, data)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DropZone", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "source", @@ -279,15 +299,20 @@ }, { "name" : "notifyEnter", + "type" : "function", "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source is now over\nthe zone. The default implementation returns this.dropNotAllowed and expects that only registered drop\nnodes can process drag drop operations, so if you need the drop zone itself to be able to process drops\nyou should override this method and provide a custom implementation.", + "sig" : "(source, e, data)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DropZone", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "source", @@ -318,15 +343,20 @@ }, { "name" : "notifyDrop", + "type" : "function", "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the dragged item has\nbeen dropped on it. The drag zone will look up the target node based on the event passed in, and if there\nis a node registered for that event, it will delegate to {@link #onNodeDrop} for node-specific handling,\notherwise it will call {@link #onContainerDrop}.", + "sig" : "(source, e, data)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DropZone", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "source", @@ -357,15 +387,20 @@ }, { "name" : "onNodeOut", + "type" : "function", "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dragged out of\nthe drop node without dropping. This method has no default implementation and should be overridden to provide\nnode-specific processing if necessary.", + "sig" : "(nodeData, source, e, data)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DropZone", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "nodeData", @@ -396,15 +431,20 @@ }, { "name" : "onContainerOver", + "type" : "function", "desc" : "Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is being dragged over it,\nbut not over any of its registered drop nodes. The default implementation returns this.dropNotAllowed, so\nit should be overridden to provide the proper feedback if necessary.", + "sig" : "(source, e, data)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DropZone", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "source", @@ -435,15 +475,20 @@ }, { "name" : "getTargetFromEvent", + "type" : "function", "desc" : "Returns a custom data object associated with the DOM node that is the target of the event. By default\nthis looks up the event target in the {@link Roo.dd.Registry}, although you can override this method to\nprovide your own custom lookup.", + "sig" : "(e)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DropZone", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -462,15 +507,20 @@ }, { "name" : "onNodeOver", + "type" : "function", "desc" : "Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is over a drop node\nthat it has registered. The default implementation returns this.dropNotAllowed, so it should be\noverridden to provide the proper feedback.", + "sig" : "(nodeData, source, e, data)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DropZone", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "nodeData", @@ -507,15 +557,20 @@ }, { "name" : "setHandleElId", + "type" : "function", "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -528,15 +583,20 @@ }, { "name" : "init", + "type" : "function", "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -561,15 +621,20 @@ }, { "name" : "removeInvalidHandleType", + "type" : "function", "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "tagName", @@ -582,29 +647,39 @@ }, { "name" : "unreg", + "type" : "function", "desc" : "Remove all drag and drop hooks for this element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "addInvalidHandleType", + "type" : "function", "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "tagName", @@ -617,15 +692,20 @@ }, { "name" : "onDragDrop", + "type" : "function", "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -644,15 +724,20 @@ }, { "name" : "removeInvalidHandleId", + "type" : "function", "desc" : "Unsets an invalid handle id", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -665,29 +750,39 @@ }, { "name" : "onAvailable", + "type" : "function", "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setOuterHandleElId", + "type" : "function", "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -700,15 +795,20 @@ }, { "name" : "onMouseUp", + "type" : "function", "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -721,15 +821,20 @@ }, { "name" : "getDragEl", + "type" : "function", "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -741,15 +846,20 @@ }, { "name" : "setYConstraint", + "type" : "function", "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "sig" : "(iUp, iDown, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iUp", @@ -774,29 +884,39 @@ }, { "name" : "clearConstraints", + "type" : "function", "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onInvalidDrop", + "type" : "function", "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -809,15 +929,20 @@ }, { "name" : "addInvalidHandleId", + "type" : "function", "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -830,15 +955,20 @@ }, { "name" : "removeInvalidHandleClass", + "type" : "function", "desc" : "Unsets an invalid css class", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cssClass", @@ -851,15 +981,20 @@ }, { "name" : "onDragOut", + "type" : "function", "desc" : "Abstract method called when we are no longer hovering over an element", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -878,15 +1013,20 @@ }, { "name" : "setDragElId", + "type" : "function", "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -899,15 +1039,20 @@ }, { "name" : "endDrag", + "type" : "function", "desc" : "Fired when we are done dragging the object", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -920,15 +1065,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns a reference to the linked element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -940,15 +1090,20 @@ }, { "name" : "onDrag", + "type" : "function", "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -961,15 +1116,20 @@ }, { "name" : "onDragEnter", + "type" : "function", "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -988,29 +1148,39 @@ }, { "name" : "lock", + "type" : "function", "desc" : "Lock this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onMouseDown", + "type" : "function", "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -1023,57 +1193,77 @@ }, { "name" : "applyConfig", + "type" : "function", "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "unlock", + "type" : "function", "desc" : "Unlock this instace", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isTarget", + "type" : "function", "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setInitPosition", + "type" : "function", "desc" : "Stores the initial placement of the linked element.", + "sig" : "(diffX, diffY)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "diffX", @@ -1092,15 +1282,20 @@ }, { "name" : "initTarget", + "type" : "function", "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -1125,15 +1320,20 @@ }, { "name" : "addToGroup", + "type" : "function", "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sGroup", @@ -1146,15 +1346,20 @@ }, { "name" : "onDragOver", + "type" : "function", "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -1173,15 +1378,20 @@ }, { "name" : "toString", + "type" : "function", "desc" : "toString method", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1193,15 +1403,20 @@ }, { "name" : "setPadding", + "type" : "function", "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "sig" : "(iTop, iRight, iBot, iLeft)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iTop", @@ -1232,15 +1447,20 @@ }, { "name" : "removeFromGroup", + "type" : "function", "desc" : "Remove's this instance from the supplied interaction group", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sGroup", @@ -1253,15 +1473,20 @@ }, { "name" : "addInvalidHandleClass", + "type" : "function", "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cssClass", @@ -1274,15 +1499,20 @@ }, { "name" : "startDrag", + "type" : "function", "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "sig" : "(X, Y)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "X", @@ -1301,29 +1531,39 @@ }, { "name" : "padding", + "type" : "function", "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "resetConstraints", + "type" : "function", "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "sig" : "(maintainOffset)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "maintainOffset", @@ -1336,29 +1576,39 @@ }, { "name" : "clearTicks", + "type" : "function", "desc" : "Clears any tick interval defined for this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isLocked", + "type" : "function", "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1370,15 +1620,20 @@ }, { "name" : "setXConstraint", + "type" : "function", "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "sig" : "(iLeft, iRight, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iLeft", @@ -1403,15 +1658,20 @@ }, { "name" : "isValidHandleChild", + "type" : "function", "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -1430,29 +1690,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1483,15 +1753,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1516,15 +1791,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1537,15 +1817,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1558,15 +1843,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1591,15 +1881,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1624,15 +1919,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1651,15 +1951,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1684,15 +1989,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1725,7 +2035,9 @@ "events" : [ { "name" : "out", + "type" : "function", "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged\nout of the target without dropping. This default implementation simply removes the CSS class specified by\noverClass (if any) from the drop element.", + "sig" : "function (source, e, data)\n{\n\n}", "memberOf" : "Roo.dd.DropTarget", "example" : "", "deprecated" : "", @@ -1755,7 +2067,9 @@ }, { "name" : "over", + "type" : "function", "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.valid to true|false", + "sig" : "function (source, e, data)\n{\n\n}", "memberOf" : "Roo.dd.DropTarget", "example" : "", "deprecated" : "", @@ -1785,7 +2099,9 @@ }, { "name" : "enter", + "type" : "function", "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.valid to true|false", + "sig" : "function (source, e, data)\n{\n\n}", "memberOf" : "Roo.dd.DropTarget", "example" : "", "deprecated" : "", @@ -1815,7 +2131,9 @@ }, { "name" : "drop", + "type" : "function", "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has\nbeen dropped on it. This method has no default implementation and returns false, so you must provide an\nimplementation that does something to process the drop event and returns true so that the drag source's\nrepair action does not run.\n\nIMPORTANT : it should set this.success", + "sig" : "function (source, e, data)\n{\n\n}", "memberOf" : "Roo.dd.DropTarget", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.dd.Registry.json b/docs/symbols/Roo.dd.Registry.json index 7c0a571e9b..66fbbbeac1 100644 --- a/docs/symbols/Roo.dd.Registry.json +++ b/docs/symbols/Roo.dd.Registry.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "getHandleFromEvent", + "type" : "function", "desc" : "Returns the handle that is registered for the DOM node that is the target of the event", + "sig" : "(e)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.Registry", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -43,15 +50,20 @@ }, { "name" : "getTargetFromEvent", + "type" : "function", "desc" : "Returns a custom data object that is registered for the DOM node that is the target of the event", + "sig" : "(e)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.Registry", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -70,15 +82,20 @@ }, { "name" : "register", + "type" : "function", "desc" : "Register a drag drop element", + "sig" : "(element, data)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.Registry", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "element", @@ -97,15 +114,20 @@ }, { "name" : "unregister", + "type" : "function", "desc" : "Unregister a drag drop element", + "sig" : "(element)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.Registry", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "element", @@ -118,15 +140,20 @@ }, { "name" : "getHandle", + "type" : "function", "desc" : "Returns the handle registered for a DOM Node by id", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.Registry", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -145,15 +172,20 @@ }, { "name" : "getTarget", + "type" : "function", "desc" : "Returns a custom data object that is registered for a DOM node by id", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.Registry", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", diff --git a/docs/symbols/Roo.dd.ScrollManager.json b/docs/symbols/Roo.dd.ScrollManager.json index fd02ef71d4..8b7a7eb20e 100644 --- a/docs/symbols/Roo.dd.ScrollManager.json +++ b/docs/symbols/Roo.dd.ScrollManager.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "register", + "type" : "function", "desc" : "Registers new overflow element(s) to auto scroll", + "sig" : "(el)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.ScrollManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -37,15 +44,20 @@ }, { "name" : "unregister", + "type" : "function", "desc" : "Unregisters overflow element(s) so they are no longer scrolled", + "sig" : "(el)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.ScrollManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -58,15 +70,20 @@ }, { "name" : "refreshCache", + "type" : "function", "desc" : "Manually trigger a cache refresh.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.ScrollManager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] } diff --git a/docs/symbols/Roo.dd.StatusProxy.json b/docs/symbols/Roo.dd.StatusProxy.json index d346d4c955..a51132fdea 100644 --- a/docs/symbols/Roo.dd.StatusProxy.json +++ b/docs/symbols/Roo.dd.StatusProxy.json @@ -19,34 +19,39 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "dropNotAllowed", "type" : "String", "desc" : "The CSS class to apply to the status element when drop is not allowed (defaults to \"x-dd-drop-nodrop\").", - "memberOf" : "Roo.dd.StatusProxy", - "optvals" : [] + "memberOf" : "" }, { "name" : "dropAllowed", "type" : "String", "desc" : "The CSS class to apply to the status element when drop is allowed (defaults to \"x-dd-drop-ok\").", - "memberOf" : "Roo.dd.StatusProxy", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "reset", + "type" : "function", "desc" : "Resets the status indicator to the default dropNotAllowed value", + "sig" : "(clearGhost)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.StatusProxy", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "clearGhost", @@ -59,15 +64,20 @@ }, { "name" : "getGhost", + "type" : "function", "desc" : "Returns the ghost element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.StatusProxy", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -79,15 +89,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the underlying proxy {@link Roo.Layer}", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.StatusProxy", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -99,29 +114,39 @@ }, { "name" : "sync", + "type" : "function", "desc" : "Force the Layer to sync its shadow and shim positions to the element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.StatusProxy", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "hide", + "type" : "function", "desc" : "Hides the proxy", + "sig" : "(clear)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.StatusProxy", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "clear", @@ -134,43 +159,58 @@ }, { "name" : "show", + "type" : "function", "desc" : "Displays this proxy", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.StatusProxy", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "stop", + "type" : "function", "desc" : "Stops the repair animation if it's currently running", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.StatusProxy", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setStatus", + "type" : "function", "desc" : "Updates the proxy's visual element to indicate the status of whether or not drop is allowed\nover the current target element.", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.StatusProxy", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cssClass", @@ -183,15 +223,20 @@ }, { "name" : "update", + "type" : "function", "desc" : "Updates the contents of the ghost element", + "sig" : "(html)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.StatusProxy", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "html", @@ -204,15 +249,20 @@ }, { "name" : "repair", + "type" : "function", "desc" : "Causes the proxy to return to its position of origin via an animation. Should be called after an\ninvalid drop operation by the item being dragged.", + "sig" : "(xy, callback, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.StatusProxy", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "xy", diff --git a/docs/symbols/Roo.dd.json b/docs/symbols/Roo.dd.json index 757928d862..e47c4981bb 100644 --- a/docs/symbols/Roo.dd.json +++ b/docs/symbols/Roo.dd.json @@ -12,6 +12,8 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.form.Action.json b/docs/symbols/Roo.form.Action.json index c7defd60ac..fbd02c690a 100644 --- a/docs/symbols/Roo.form.Action.json +++ b/docs/symbols/Roo.form.Action.json @@ -25,6 +25,8 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.form.BasicForm.json b/docs/symbols/Roo.form.BasicForm.json index 3b02fba2f6..d9a9b577ff 100644 --- a/docs/symbols/Roo.form.BasicForm.json +++ b/docs/symbols/Roo.form.BasicForm.json @@ -27,100 +27,93 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "fileUpload", "type" : "Boolean", "desc" : "Set to true if this form is a file upload.", - "memberOf" : "Roo.form.BasicForm", - "optvals" : [] + "memberOf" : "" }, { "name" : "method", "type" : "String", "desc" : "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.", - "memberOf" : "Roo.form.BasicForm", - "optvals" : [] + "memberOf" : "" }, { "name" : "errorMask", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.form.BasicForm", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "timeout", "type" : "Number", "desc" : "Timeout for form actions in seconds (default is 30 seconds).", - "memberOf" : "Roo.form.BasicForm", - "optvals" : [] + "memberOf" : "" }, { "name" : "baseParams", "type" : "Object", "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.", - "memberOf" : "Roo.form.BasicForm", - "optvals" : [] + "memberOf" : "" }, { "name" : "trackResetOnLoad", "type" : "Boolean", "desc" : "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.", - "memberOf" : "Roo.form.BasicForm", - "optvals" : [] + "memberOf" : "" }, { "name" : "reader", "type" : "DataReader", "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.", - "memberOf" : "Roo.form.BasicForm", - "optvals" : [] + "memberOf" : "" }, { "name" : "errorReader", "type" : "DataReader", "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on \"submit\" actions.\nThis is completely optional as there is built-in support for processing JSON.", - "memberOf" : "Roo.form.BasicForm", - "optvals" : [] + "memberOf" : "" }, { "name" : "url", "type" : "String", "desc" : "The URL to use for form actions if one isn't supplied in the action options.", - "memberOf" : "Roo.form.BasicForm", - "optvals" : [] + "memberOf" : "" }, { "name" : "maskOffset", "type" : "Number", "desc" : "Default 100", - "memberOf" : "Roo.form.BasicForm", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "remove", + "type" : "function", "desc" : "Removes a field from the items collection (does NOT remove its markup).", + "sig" : "(field)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "field", @@ -139,15 +132,20 @@ }, { "name" : "loadRecord", + "type" : "function", "desc" : "Loads an Roo.data.Record into this form.", + "sig" : "(record)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "record", @@ -166,15 +164,20 @@ }, { "name" : "load", + "type" : "function", "desc" : "Shortcut to do a load action.", + "sig" : "(options)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "options", @@ -193,15 +196,20 @@ }, { "name" : "doAction", + "type" : "function", "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.", + "sig" : "(actionName, options)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "actionName", @@ -226,15 +234,20 @@ }, { "name" : "getValues", + "type" : "function", "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.", + "sig" : "(asString)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "asString", @@ -253,15 +266,20 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -273,15 +291,20 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clears all invalid messages in this form.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -293,15 +316,20 @@ }, { "name" : "isDirty", + "type" : "function", "desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -313,15 +341,20 @@ }, { "name" : "updateRecord", + "type" : "function", "desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.", + "sig" : "(record)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "record", @@ -340,15 +373,20 @@ }, { "name" : "hasChanged", + "type" : "function", "desc" : "Returns true if any fields in this form have changed since their original load. (New version)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -360,15 +398,20 @@ }, { "name" : "applyToFields", + "type" : "function", "desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.", + "sig" : "(values)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "values", @@ -387,15 +430,20 @@ }, { "name" : "getFieldValues", + "type" : "function", "desc" : "Returns the fields in this form as an object with key/value pairs. \nThis differs from getValues as it calls getValue on each child item, rather than using dom data.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -407,15 +455,20 @@ }, { "name" : "submit", + "type" : "function", "desc" : "Shortcut to do a submit action.", + "sig" : "(options)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "options", @@ -434,15 +487,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark fields in this form invalid in bulk.", + "sig" : "(errors)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "errors", @@ -461,15 +519,20 @@ }, { "name" : "setValues", + "type" : "function", "desc" : "Set values for fields in this form in bulk.", + "sig" : "(values)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "values", @@ -488,15 +551,20 @@ }, { "name" : "isValid", + "type" : "function", "desc" : "Returns true if client-side validation on the form is successful.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -508,15 +576,20 @@ }, { "name" : "invalidFields", + "type" : "function", "desc" : "Returns array of invalid form fields.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -528,15 +601,20 @@ }, { "name" : "render", + "type" : "function", "desc" : "Looks at the fields in this form, checks them for an id attribute,\nand calls applyTo on the existing dom element with that id.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -548,15 +626,20 @@ }, { "name" : "add", + "type" : "function", "desc" : "Add Roo.form components to this form.", + "sig" : "(field1, field2, etc)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "field1", @@ -587,15 +670,20 @@ }, { "name" : "applyIfToFields", + "type" : "function", "desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.", + "sig" : "(values)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "values", @@ -614,15 +702,20 @@ }, { "name" : "findField", + "type" : "function", "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -641,15 +734,20 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets this form.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -661,15 +759,20 @@ }, { "name" : "addForm", + "type" : "function", "desc" : "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms.", + "sig" : "(form)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "form", @@ -682,29 +785,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -735,15 +848,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -768,15 +886,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -789,15 +912,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -810,15 +938,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -843,15 +976,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -876,15 +1014,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -903,15 +1046,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -936,15 +1084,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -977,8 +1130,10 @@ "events" : [ { "name" : "beforeaction", + "type" : "function", "desc" : "Fires before any action is performed. Return false to cancel the action.", - "memberOf" : "Roo.form.BasicForm", + "sig" : "function (_self, action)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1001,8 +1156,10 @@ }, { "name" : "actioncomplete", + "type" : "function", "desc" : "Fires when an action is completed.", - "memberOf" : "Roo.form.BasicForm", + "sig" : "function (_self, action)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1025,8 +1182,10 @@ }, { "name" : "actionfailed", + "type" : "function", "desc" : "Fires when an action fails.", - "memberOf" : "Roo.form.BasicForm", + "sig" : "function (_self, action)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.form.Checkbox.json b/docs/symbols/Roo.form.Checkbox.json index bd5efadac7..273aca1bfc 100644 --- a/docs/symbols/Roo.form.Checkbox.json +++ b/docs/symbols/Roo.form.Checkbox.json @@ -24,233 +24,207 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "inputType", "type" : "String", "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "msgFx", "type" : "String", "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "inputValue", "type" : "String", "desc" : "The value that should go into the generated input element's value attribute", - "memberOf" : "Roo.form.Checkbox", - "optvals" : [] + "memberOf" : "" }, { "name" : "fieldLabel", "type" : "String", "desc" : "Label to use when rendering a form.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "msgTarget", "type" : "String", "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to disable the field (defaults to false).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "value", "type" : "Mixed", "desc" : "A value to initialize this field with.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "invalidClass", "type" : "String", "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the field's underlying element.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "autoCreate", "type" : "String/Object", "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})", - "memberOf" : "Roo.form.Checkbox", - "optvals" : [] + "memberOf" : "" }, { "name" : "valueOff", "type" : "String", "desc" : "The value that should go into the generated input element's value when unchecked.", - "memberOf" : "Roo.form.Checkbox", - "optvals" : [] + "memberOf" : "" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "boxLabel", "type" : "String", "desc" : "The text that appears beside the checkbox", - "memberOf" : "Roo.form.Checkbox", - "optvals" : [] + "memberOf" : "" }, { "name" : "width", "type" : "Number", "desc" : "width (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldClass", "type" : "String", "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")", - "memberOf" : "Roo.form.Checkbox", - "optvals" : [] + "memberOf" : "" }, { "name" : "checked", "type" : "Boolean", "desc" : "True if the the checkbox should render already checked (defaults to false)", - "memberOf" : "Roo.form.Checkbox", - "optvals" : [] + "memberOf" : "" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)", - "memberOf" : "Roo.form.Checkbox", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "String", "desc" : "The field's HTML name attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "qtip", "type" : "String", "desc" : "Mouse over tip", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "height", "type" : "Number", "desc" : "height (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "setValue", + "type" : "function", "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.", + "sig" : "(value, suppressEvent)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Checkbox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -269,15 +243,20 @@ }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the checked state of the checkbox.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Checkbox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -289,15 +268,20 @@ }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -309,15 +293,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -329,15 +318,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -350,15 +344,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -370,15 +369,20 @@ }, { "name" : "applyTo", + "type" : "function", "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -397,43 +401,58 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isDirty", + "type" : "function", "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -446,29 +465,39 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isValid", + "type" : "function", "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "preventMark", @@ -487,43 +516,58 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "hasChanged", + "type" : "function", "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -536,15 +580,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -563,29 +612,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -610,15 +669,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -637,15 +701,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -676,15 +745,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -697,15 +771,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -717,15 +796,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -744,15 +828,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -771,15 +860,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -791,15 +885,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -812,43 +911,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -861,15 +975,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -881,15 +1000,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -908,15 +1032,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -928,15 +1057,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -948,15 +1082,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -975,15 +1114,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -995,15 +1139,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1015,29 +1164,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1068,15 +1227,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1101,15 +1265,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1122,15 +1291,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1143,15 +1317,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1176,15 +1355,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1209,15 +1393,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1236,15 +1425,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1269,15 +1463,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1310,8 +1509,10 @@ "events" : [ { "name" : "check", + "type" : "function", "desc" : "Fires when the checkbox is checked or unchecked.", - "memberOf" : "Roo.form.Checkbox", + "sig" : "function (_self, checked)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1334,7 +1535,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1352,7 +1555,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1370,7 +1575,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1394,7 +1601,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1412,7 +1621,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1436,7 +1647,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1460,7 +1673,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1490,7 +1705,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1520,7 +1737,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1562,7 +1781,9 @@ }, { "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" : "", @@ -1580,7 +1801,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1598,7 +1821,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1616,7 +1841,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1634,7 +1861,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1652,7 +1881,9 @@ }, { "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" : "", @@ -1670,7 +1901,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1688,7 +1921,9 @@ }, { "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" : "", @@ -1706,7 +1941,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1724,7 +1961,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.Column.json b/docs/symbols/Roo.form.Column.json index 511c4f974d..0f8be215fb 100644 --- a/docs/symbols/Roo.form.Column.json +++ b/docs/symbols/Roo.form.Column.json @@ -23,114 +23,105 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "labelAlign", "type" : "String", "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "Roo.form.Layout" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "hideLabels", "type" : "Boolean", "desc" : "True to suppress the display of field labels in this layout (defaults to false)", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "Roo.form.Layout" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String/Object/Function", "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "Roo.form.Layout" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "labelWidth", "type" : "Number", "desc" : "Fixed width in pixels of all field labels (defaults to undefined)", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "Roo.form.Layout" }, { "name" : "labelSeparator", "type" : "String", "desc" : "The separator to use after field labels (defaults to ':')", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "Roo.form.Layout" }, { "name" : "autoCreate", "type" : "String/Object", "desc" : "A DomHelper element spec used to autocreate the column (defaults to {tag: 'div', cls: 'x-form-ct x-form-column'})", - "memberOf" : "Roo.form.Column", - "optvals" : [] + "memberOf" : "" }, { "name" : "clear", "type" : "Boolean", "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "Roo.form.Layout" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "width", "type" : "Number/String", "desc" : "The fixed width of the column in pixels or CSS value (defaults to \"auto\")", - "memberOf" : "Roo.form.Column", - "optvals" : [] + "memberOf" : "" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "addxtype", + "type" : "function", "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column", + "sig" : "(config)", + "static" : false, + "memberOf" : "Roo.form.Layout", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Layout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -143,15 +134,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -163,15 +159,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -184,43 +185,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -233,15 +249,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -253,15 +274,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -280,15 +306,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -300,15 +331,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -320,15 +356,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -347,15 +388,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -367,15 +413,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -387,29 +438,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -440,15 +501,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -473,15 +539,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -494,15 +565,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -515,15 +591,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -548,15 +629,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -581,15 +667,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -608,15 +699,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -641,15 +737,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -682,7 +783,9 @@ "events" : [ { "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" : "", @@ -700,7 +803,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -718,7 +823,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -736,7 +843,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -754,7 +863,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -772,7 +883,9 @@ }, { "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" : "", @@ -790,7 +903,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -808,7 +923,9 @@ }, { "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" : "", @@ -826,7 +943,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -844,7 +963,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.ComboBox.json b/docs/symbols/Roo.form.ComboBox.json index a1ebc2642e..d8b48ff487 100644 --- a/docs/symbols/Roo.form.ComboBox.json +++ b/docs/symbols/Roo.form.ComboBox.json @@ -26,576 +26,501 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "triggerClass", "type" : "String", "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be appended if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "pageSize", "type" : "Number", "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "queryParam", "type" : "String", "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "title", "type" : "String", "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to disable the field (defaults to false).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "resizable", "type" : "Boolean", "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "name", "type" : "String", "desc" : "The field's HTML name attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "editable", "type" : "Boolean", "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "width", "type" : "Number", "desc" : "width (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "regexText", "type" : "String", "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "listWidth", "type" : "Number", "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "tpl", "type" : "String/Roo.Template", "desc" : "The template to use to render the output", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "typeAheadDelay", "type" : "Number", "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "height", "type" : "Number", "desc" : "height (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "disableClear", "type" : "Boolean", "desc" : "Disable showing of clear button.", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "store", "type" : "Roo.data.Store", "desc" : "The data store to which this combo is bound (defaults to undefined)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "emptyText", "type" : "String", "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "value", "type" : "Mixed", "desc" : "A value to initialize this field with.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "msgFx", "type" : "String", "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "allQuery", "type" : "String", "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "minListWidth", "type" : "Number", "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "alwaysQuery", "type" : "Boolean", "desc" : "Disable caching of results, and always send query", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "msgTarget", "type" : "String", "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "shadow", "type" : "Boolean/String", "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "valueNotFoundText", "type" : "String", "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "hiddenName", "type" : "String", "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "selectedClass", "type" : "String", "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "displayField", "type" : "String", "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "hideTrigger", "type" : "Boolean", "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", - "memberOf" : "Roo.form.TriggerField", - "optvals" : [] + "memberOf" : "Roo.form.TriggerField" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the field's underlying element.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "listAlign", "type" : "String", "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "typeAhead", "type" : "Boolean", "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "forceSelection", "type" : "Boolean", "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "triggerAction", "type" : "String", "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "inputType", "type" : "String", "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldClass", "type" : "String", "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "autoCreate", "type" : "Boolean/Object", "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "minChars", "type" : "Number", "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "growMin", "type" : "Number", "desc" : "", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "allowLeadingSpace", "type" : "Boolean", "desc" : "True to prevent the stripping of leading white space", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "invalidClass", "type" : "String", "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "blockFocus", "type" : "Boolean", "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "fieldLabel", "type" : "String", "desc" : "Label to use when rendering a form.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "growMax", "type" : "Number", "desc" : "", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "transform", "type" : "String/HTMLElement/Element", "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "listClass", "type" : "String", "desc" : "CSS class to apply to the dropdown list element (defaults to '')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "handleHeight", "type" : "Number", "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "grow", "type" : "Boolean", "desc" : "", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "queryDelay", "type" : "Number", "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "mode", "type" : "String", "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "qtip", "type" : "String", "desc" : "Mouse over tip", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maxHeight", "type" : "Number", "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "valueField", "type" : "String", "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "loadingText", "type" : "String", "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "lazyRender", "type" : "Boolean", "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" } ], "methods" : [ { "name" : "getValue", + "type" : "function", "desc" : "Returns the currently selected field value or empty string if no value is set.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -607,29 +532,39 @@ }, { "name" : "expand", + "type" : "function", "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setValue", + "type" : "function", "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -642,15 +577,20 @@ }, { "name" : "select", + "type" : "function", "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "sig" : "(index, scrollIntoView)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -669,29 +609,39 @@ }, { "name" : "isExpanded", + "type" : "function", "desc" : "Returns true if the dropdown list is expanded, else false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "doQuery", + "type" : "function", "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.", + "sig" : "(query, forceAll)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "query", @@ -710,15 +660,20 @@ }, { "name" : "setFromData", + "type" : "function", "desc" : "Sets the value of the field based on a object which is related to the record format for the store.", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -731,15 +686,20 @@ }, { "name" : "selectByValue", + "type" : "function", "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "sig" : "(value, scrollIntoView)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -764,15 +724,20 @@ }, { "name" : "setEditable", + "type" : "function", "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -785,43 +750,58 @@ }, { "name" : "collapse", + "type" : "function", "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "clearValue", + "type" : "function", "desc" : "Clears any text/value currently set in the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onTriggerClick", + "type" : "function", "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.form.TriggerField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TriggerField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -834,29 +814,39 @@ }, { "name" : "autoSize", + "type" : "function", "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TriggerField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TriggerField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "selectText", + "type" : "function", "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "start", @@ -875,15 +865,20 @@ }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -902,29 +897,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -936,15 +941,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -956,15 +966,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -977,15 +992,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -997,15 +1017,20 @@ }, { "name" : "applyTo", + "type" : "function", "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -1024,43 +1049,58 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isDirty", + "type" : "function", "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -1073,29 +1113,39 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isValid", + "type" : "function", "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "preventMark", @@ -1114,29 +1164,39 @@ }, { "name" : "hasChanged", + "type" : "function", "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -1149,15 +1209,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -1176,29 +1241,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -1223,15 +1298,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -1250,15 +1330,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -1289,15 +1374,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -1310,15 +1400,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1330,15 +1425,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -1357,15 +1457,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -1384,15 +1489,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1404,15 +1514,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -1425,43 +1540,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -1474,15 +1604,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1494,15 +1629,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -1521,15 +1661,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1541,15 +1686,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1561,15 +1711,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1588,15 +1743,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1608,15 +1768,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1628,29 +1793,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1681,15 +1856,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1714,15 +1894,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1735,15 +1920,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1756,15 +1946,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1789,15 +1984,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1822,15 +2022,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1849,15 +2054,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1882,15 +2092,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1923,8 +2138,10 @@ "events" : [ { "name" : "add", + "type" : "function", "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)", - "memberOf" : "Roo.form.ComboBox", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1941,8 +2158,10 @@ }, { "name" : "expand", + "type" : "function", "desc" : "Fires when the dropdown list is expanded", - "memberOf" : "Roo.form.ComboBox", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1959,8 +2178,10 @@ }, { "name" : "collapse", + "type" : "function", "desc" : "Fires when the dropdown list is collapsed", - "memberOf" : "Roo.form.ComboBox", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1977,8 +2198,10 @@ }, { "name" : "select", + "type" : "function", "desc" : "Fires when a list item is selected", - "memberOf" : "Roo.form.ComboBox", + "sig" : "function (combo, record, index)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -2007,8 +2230,10 @@ }, { "name" : "edit", + "type" : "function", "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)", - "memberOf" : "Roo.form.ComboBox", + "sig" : "function (combo, record)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -2031,8 +2256,10 @@ }, { "name" : "beforequery", + "type" : "function", "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:", - "memberOf" : "Roo.form.ComboBox", + "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -2073,8 +2300,10 @@ }, { "name" : "beforeselect", + "type" : "function", "desc" : "Fires before a list item is selected. Return false to cancel the selection.", - "memberOf" : "Roo.form.ComboBox", + "sig" : "function (combo, record, index)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -2103,7 +2332,9 @@ }, { "name" : "autosize", + "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", @@ -2127,7 +2358,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2145,7 +2378,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2163,7 +2398,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2187,7 +2424,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2205,7 +2444,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2229,7 +2470,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2253,7 +2496,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2283,7 +2528,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -2313,7 +2560,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -2355,7 +2604,9 @@ }, { "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" : "", @@ -2373,7 +2624,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2391,7 +2644,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2409,7 +2664,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2427,7 +2684,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2445,7 +2704,9 @@ }, { "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" : "", @@ -2463,7 +2724,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2481,7 +2744,9 @@ }, { "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" : "", @@ -2499,7 +2764,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2517,7 +2784,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.ComboBoxArray.Item.json b/docs/symbols/Roo.form.ComboBoxArray.Item.json index 3cb1d088ab..f2bfb5ecc0 100644 --- a/docs/symbols/Roo.form.ComboBoxArray.Item.json +++ b/docs/symbols/Roo.form.ComboBoxArray.Item.json @@ -23,72 +23,69 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "width", "type" : "Number", "desc" : "width (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "height", "type" : "Number", "desc" : "height (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -101,15 +98,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -128,29 +130,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -175,15 +187,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -202,15 +219,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -241,15 +263,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -262,15 +289,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -282,15 +314,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -309,15 +346,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -336,15 +378,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -356,15 +403,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -377,43 +429,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -426,15 +493,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -446,15 +518,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -473,15 +550,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -493,15 +575,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -513,15 +600,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -540,15 +632,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -560,15 +657,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -580,29 +682,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -633,15 +745,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -666,15 +783,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -687,15 +809,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -708,15 +835,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -741,15 +873,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -774,15 +911,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -801,15 +943,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -834,15 +981,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -875,7 +1027,9 @@ "events" : [ { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -905,7 +1059,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -947,7 +1103,9 @@ }, { "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" : "", @@ -965,7 +1123,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -983,7 +1143,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1001,7 +1163,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1019,7 +1183,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1037,7 +1203,9 @@ }, { "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" : "", @@ -1055,7 +1223,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1073,7 +1243,9 @@ }, { "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" : "", @@ -1091,7 +1263,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1109,7 +1283,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.ComboBoxArray.json b/docs/symbols/Roo.form.ComboBoxArray.json index 7ec0610b06..b840c18599 100644 --- a/docs/symbols/Roo.form.ComboBoxArray.json +++ b/docs/symbols/Roo.form.ComboBoxArray.json @@ -25,352 +25,309 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to disable the field (defaults to false).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "name", "type" : "String", "desc" : "The name of the visable items on this form (eg. titles not ids)", - "memberOf" : "Roo.form.ComboBoxArray", - "optvals" : [] + "memberOf" : "" }, { "name" : "width", "type" : "Number", "desc" : "The width of the box that displays the selected element", - "memberOf" : "Roo.form.ComboBoxArray", - "optvals" : [] + "memberOf" : "" }, { "name" : "regexText", "type" : "String", "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "height", "type" : "Number", "desc" : "height (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "emptyText", "type" : "String", "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "value", "type" : "Mixed", "desc" : "A value to initialize this field with.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "msgFx", "type" : "String", "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "msgTarget", "type" : "String", "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "combo", - "type" : "Roo.form.Combo", - "desc" : "The combo box that is wrapped", - "memberOf" : "Roo.form.ComboBoxArray", - "optvals" : [] + "type" : "Roo.form.ComboBox", + "desc" : "[required] The combo box that is wrapped", + "memberOf" : "" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the field's underlying element.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "hiddenName", "type" : "String", "desc" : "The hidden name of the field, often contains an comma seperated list of names", - "memberOf" : "Roo.form.ComboBoxArray", - "optvals" : [] + "memberOf" : "" }, { "name" : "seperator", "type" : "String", "desc" : "The value seperator normally ','", - "memberOf" : "Roo.form.ComboBoxArray", - "optvals" : [] + "memberOf" : "" }, { "name" : "fieldClass", "type" : "String", "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "inputType", "type" : "String", "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "allowLeadingSpace", "type" : "Boolean", "desc" : "True to prevent the stripping of leading white space", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "autoCreate", "type" : "String/Object", "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "invalidClass", "type" : "String", "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "growMin", "type" : "Number", "desc" : "The minimum width to allow when grow = true (defaults to 30)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "fieldLabel", "type" : "String", "desc" : "Label to use when rendering a form.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "growMax", "type" : "Number", "desc" : "The maximum width to allow when grow = true (defaults to 800)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "grow", "type" : "Boolean", "desc" : "True if this field should automatically grow and shrink to its content", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "qtip", "type" : "String", "desc" : "Mouse over tip", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" } ], "methods" : [ { "name" : "validate", + "type" : "function", "desc" : "Validates the combox array value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBoxArray", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -382,15 +339,20 @@ }, { "name" : "selectText", + "type" : "function", "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "start", @@ -409,15 +371,20 @@ }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -436,43 +403,58 @@ }, { "name" : "autoSize", + "type" : "function", "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -484,15 +466,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -505,15 +492,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -525,15 +517,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -546,15 +543,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -566,15 +568,20 @@ }, { "name" : "applyTo", + "type" : "function", "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -593,43 +600,58 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isDirty", + "type" : "function", "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -642,29 +664,39 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isValid", + "type" : "function", "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "preventMark", @@ -683,29 +715,39 @@ }, { "name" : "hasChanged", + "type" : "function", "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -718,15 +760,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -745,29 +792,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -792,15 +849,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -819,15 +881,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -858,15 +925,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -879,15 +951,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -899,15 +976,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -926,15 +1008,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -953,15 +1040,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -973,15 +1065,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -994,43 +1091,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -1043,15 +1155,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1063,15 +1180,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -1090,15 +1212,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1110,15 +1237,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1130,15 +1262,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1157,15 +1294,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1177,15 +1319,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1197,29 +1344,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1250,15 +1407,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1283,15 +1445,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1304,15 +1471,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1325,15 +1497,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1358,15 +1535,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1391,15 +1573,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1418,15 +1605,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1451,15 +1643,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1492,8 +1689,10 @@ "events" : [ { "name" : "beforeremove", + "type" : "function", "desc" : "Fires before remove the value from the list", - "memberOf" : "Roo.form.ComboBoxArray", + "sig" : "function (_self, item)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1516,8 +1715,10 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Fires when remove the value from the list", - "memberOf" : "Roo.form.ComboBoxArray", + "sig" : "function (_self, item)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1540,7 +1741,9 @@ }, { "name" : "autosize", + "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", @@ -1564,7 +1767,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1582,7 +1787,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1600,7 +1807,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1624,7 +1833,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1642,7 +1853,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1666,7 +1879,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1690,7 +1905,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1720,7 +1937,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1750,7 +1969,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1792,7 +2013,9 @@ }, { "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" : "", @@ -1810,7 +2033,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1828,7 +2053,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1846,7 +2073,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1864,7 +2093,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1882,7 +2113,9 @@ }, { "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" : "", @@ -1900,7 +2133,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1918,7 +2153,9 @@ }, { "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" : "", @@ -1936,7 +2173,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1954,7 +2193,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.ComboCheck.json b/docs/symbols/Roo.form.ComboCheck.json index 0afda1cf8b..ec087afc76 100644 --- a/docs/symbols/Roo.form.ComboCheck.json +++ b/docs/symbols/Roo.form.ComboCheck.json @@ -27,576 +27,501 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "triggerClass", "type" : "String", "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be appended if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "pageSize", "type" : "Number", "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "queryParam", "type" : "String", "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to disable the field (defaults to false).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "title", "type" : "String", "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "name", "type" : "String", "desc" : "The field's HTML name attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "resizable", "type" : "Boolean", "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "width", "type" : "Number", "desc" : "width (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "editable", "type" : "Boolean", "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "regexText", "type" : "String", "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "listWidth", "type" : "Number", "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "height", "type" : "Number", "desc" : "height (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "tpl", "type" : "String/Roo.Template", "desc" : "The template to use to render the output", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "typeAheadDelay", "type" : "Number", "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "disableClear", "type" : "Boolean", "desc" : "Disable showing of clear button.", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "value", "type" : "Mixed", "desc" : "A value to initialize this field with.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "emptyText", "type" : "String", "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "store", "type" : "Roo.data.Store", "desc" : "The data store to which this combo is bound (defaults to undefined)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "msgFx", "type" : "String", "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "allQuery", "type" : "String", "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "msgTarget", "type" : "String", "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "minListWidth", "type" : "Number", "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "alwaysQuery", "type" : "Boolean", "desc" : "Disable caching of results, and always send query", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "shadow", "type" : "Boolean/String", "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "valueNotFoundText", "type" : "String", "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "hiddenName", "type" : "String", "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "selectedClass", "type" : "String", "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "displayField", "type" : "String", "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "hideTrigger", "type" : "Boolean", "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", - "memberOf" : "Roo.form.TriggerField", - "optvals" : [] + "memberOf" : "Roo.form.TriggerField" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the field's underlying element.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "listAlign", "type" : "String", "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "typeAhead", "type" : "Boolean", "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "forceSelection", "type" : "Boolean", "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "triggerAction", "type" : "String", "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "inputType", "type" : "String", "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldClass", "type" : "String", "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "autoCreate", "type" : "Boolean/Object", "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "minChars", "type" : "Number", "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "growMin", "type" : "Number", "desc" : "", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "allowLeadingSpace", "type" : "Boolean", "desc" : "True to prevent the stripping of leading white space", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "invalidClass", "type" : "String", "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "blockFocus", "type" : "Boolean", "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "fieldLabel", "type" : "String", "desc" : "Label to use when rendering a form.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "growMax", "type" : "Number", "desc" : "", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "transform", "type" : "String/HTMLElement/Element", "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "listClass", "type" : "String", "desc" : "CSS class to apply to the dropdown list element (defaults to '')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "handleHeight", "type" : "Number", "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "grow", "type" : "Boolean", "desc" : "", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "queryDelay", "type" : "Number", "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "mode", "type" : "String", "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "qtip", "type" : "String", "desc" : "Mouse over tip", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maxHeight", "type" : "Number", "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "valueField", "type" : "String", "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "loadingText", "type" : "String", "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "lazyRender", "type" : "Boolean", "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" } ], "methods" : [ { "name" : "getValue", + "type" : "function", "desc" : "Returns the currently selected field value or empty string if no value is set.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -608,29 +533,39 @@ }, { "name" : "expand", + "type" : "function", "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setValue", + "type" : "function", "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -643,15 +578,20 @@ }, { "name" : "select", + "type" : "function", "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "sig" : "(index, scrollIntoView)", + "static" : false, + "memberOf" : "Roo.form.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -670,29 +610,39 @@ }, { "name" : "isExpanded", + "type" : "function", "desc" : "Returns true if the dropdown list is expanded, else false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "doQuery", + "type" : "function", "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.", + "sig" : "(query, forceAll)", + "static" : false, + "memberOf" : "Roo.form.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "query", @@ -711,15 +661,20 @@ }, { "name" : "setFromData", + "type" : "function", "desc" : "Sets the value of the field based on a object which is related to the record format for the store.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -732,15 +687,20 @@ }, { "name" : "selectByValue", + "type" : "function", "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "sig" : "(value, scrollIntoView)", + "static" : false, + "memberOf" : "Roo.form.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -765,15 +725,20 @@ }, { "name" : "setEditable", + "type" : "function", "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -786,43 +751,58 @@ }, { "name" : "collapse", + "type" : "function", "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "clearValue", + "type" : "function", "desc" : "Clears any text/value currently set in the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onTriggerClick", + "type" : "function", "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.form.TriggerField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TriggerField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -835,29 +815,39 @@ }, { "name" : "autoSize", + "type" : "function", "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TriggerField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TriggerField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "selectText", + "type" : "function", "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "start", @@ -876,15 +866,20 @@ }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -903,29 +898,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -937,15 +942,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -957,15 +967,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -978,15 +993,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -998,15 +1018,20 @@ }, { "name" : "applyTo", + "type" : "function", "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -1025,43 +1050,58 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isDirty", + "type" : "function", "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -1074,29 +1114,39 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isValid", + "type" : "function", "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "preventMark", @@ -1115,29 +1165,39 @@ }, { "name" : "hasChanged", + "type" : "function", "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -1150,15 +1210,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -1177,29 +1242,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -1224,15 +1299,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -1251,15 +1331,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -1290,15 +1375,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -1311,15 +1401,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1331,15 +1426,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -1358,15 +1458,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -1385,15 +1490,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1405,15 +1515,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -1426,43 +1541,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -1475,15 +1605,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1495,15 +1630,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -1522,15 +1662,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1542,15 +1687,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1562,15 +1712,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1589,15 +1744,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1609,15 +1769,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1629,29 +1794,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1682,15 +1857,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1715,15 +1895,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1736,15 +1921,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1757,15 +1947,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1790,15 +1985,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1823,15 +2023,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1850,15 +2055,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1883,15 +2093,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1924,7 +2139,9 @@ "events" : [ { "name" : "add", + "type" : "function", "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)", + "sig" : "function (combo)\n{\n\n}", "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", @@ -1942,7 +2159,9 @@ }, { "name" : "expand", + "type" : "function", "desc" : "Fires when the dropdown list is expanded", + "sig" : "function (combo)\n{\n\n}", "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", @@ -1960,7 +2179,9 @@ }, { "name" : "collapse", + "type" : "function", "desc" : "Fires when the dropdown list is collapsed", + "sig" : "function (combo)\n{\n\n}", "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", @@ -1978,7 +2199,9 @@ }, { "name" : "select", + "type" : "function", "desc" : "Fires when a list item is selected", + "sig" : "function (combo, record, index)\n{\n\n}", "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", @@ -2008,7 +2231,9 @@ }, { "name" : "edit", + "type" : "function", "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)", + "sig" : "function (combo, record)\n{\n\n}", "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", @@ -2032,7 +2257,9 @@ }, { "name" : "beforequery", + "type" : "function", "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:", + "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}", "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", @@ -2074,7 +2301,9 @@ }, { "name" : "beforeselect", + "type" : "function", "desc" : "Fires before a list item is selected. Return false to cancel the selection.", + "sig" : "function (combo, record, index)\n{\n\n}", "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", @@ -2104,7 +2333,9 @@ }, { "name" : "autosize", + "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", @@ -2128,7 +2359,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2146,7 +2379,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2164,7 +2399,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2188,7 +2425,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2206,7 +2445,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2230,7 +2471,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2254,7 +2497,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2284,7 +2529,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -2314,7 +2561,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -2356,7 +2605,9 @@ }, { "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" : "", @@ -2374,7 +2625,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2392,7 +2645,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2410,7 +2665,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2428,7 +2685,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2446,7 +2705,9 @@ }, { "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" : "", @@ -2464,7 +2725,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2482,7 +2745,9 @@ }, { "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" : "", @@ -2500,7 +2765,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2518,7 +2785,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.ComboNested.json b/docs/symbols/Roo.form.ComboNested.json index c87f1f19ad..c758e7bae8 100644 --- a/docs/symbols/Roo.form.ComboNested.json +++ b/docs/symbols/Roo.form.ComboNested.json @@ -27,576 +27,501 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "triggerClass", "type" : "String", "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be appended if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "pageSize", "type" : "Number", "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "queryParam", "type" : "String", "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to disable the field (defaults to false).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "title", "type" : "String", "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "name", "type" : "String", "desc" : "The field's HTML name attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "resizable", "type" : "Boolean", "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "width", "type" : "Number", "desc" : "width (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "editable", "type" : "Boolean", "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "regexText", "type" : "String", "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "listWidth", "type" : "Number", "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "height", "type" : "Number", "desc" : "height (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "tpl", "type" : "String/Roo.Template", "desc" : "The template to use to render the output", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "typeAheadDelay", "type" : "Number", "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "disableClear", "type" : "Boolean", "desc" : "Disable showing of clear button.", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "value", "type" : "Mixed", "desc" : "A value to initialize this field with.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "emptyText", "type" : "String", "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "store", "type" : "Roo.data.Store", "desc" : "The data store to which this combo is bound (defaults to undefined)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "msgFx", "type" : "String", "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "allQuery", "type" : "String", "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "msgTarget", "type" : "String", "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "minListWidth", "type" : "Number", "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "alwaysQuery", "type" : "Boolean", "desc" : "Disable caching of results, and always send query", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "shadow", "type" : "Boolean/String", "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "valueNotFoundText", "type" : "String", "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "hiddenName", "type" : "String", "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "selectedClass", "type" : "String", "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "displayField", "type" : "String", "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "hideTrigger", "type" : "Boolean", "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", - "memberOf" : "Roo.form.TriggerField", - "optvals" : [] + "memberOf" : "Roo.form.TriggerField" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the field's underlying element.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "listAlign", "type" : "String", "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "typeAhead", "type" : "Boolean", "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "forceSelection", "type" : "Boolean", "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "triggerAction", "type" : "String", "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "inputType", "type" : "String", "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldClass", "type" : "String", "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "autoCreate", "type" : "Boolean/Object", "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "minChars", "type" : "Number", "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "growMin", "type" : "Number", "desc" : "", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "allowLeadingSpace", "type" : "Boolean", "desc" : "True to prevent the stripping of leading white space", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "invalidClass", "type" : "String", "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "blockFocus", "type" : "Boolean", "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "fieldLabel", "type" : "String", "desc" : "Label to use when rendering a form.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "growMax", "type" : "Number", "desc" : "", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "transform", "type" : "String/HTMLElement/Element", "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "listClass", "type" : "String", "desc" : "CSS class to apply to the dropdown list element (defaults to '')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "handleHeight", "type" : "Number", "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "grow", "type" : "Boolean", "desc" : "", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "queryDelay", "type" : "Number", "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "mode", "type" : "String", "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "qtip", "type" : "String", "desc" : "Mouse over tip", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maxHeight", "type" : "Number", "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "valueField", "type" : "String", "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "loadingText", "type" : "String", "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "lazyRender", "type" : "Boolean", "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)", - "memberOf" : "Roo.form.ComboBox", - "optvals" : [] + "memberOf" : "Roo.form.ComboBox" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" } ], "methods" : [ { "name" : "getValue", + "type" : "function", "desc" : "Returns the currently selected field value or empty string if no value is set.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -608,29 +533,39 @@ }, { "name" : "expand", + "type" : "function", "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setValue", + "type" : "function", "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -643,15 +578,20 @@ }, { "name" : "select", + "type" : "function", "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "sig" : "(index, scrollIntoView)", + "static" : false, + "memberOf" : "Roo.form.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -670,29 +610,39 @@ }, { "name" : "isExpanded", + "type" : "function", "desc" : "Returns true if the dropdown list is expanded, else false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "doQuery", + "type" : "function", "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.", + "sig" : "(query, forceAll)", + "static" : false, + "memberOf" : "Roo.form.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "query", @@ -711,15 +661,20 @@ }, { "name" : "setFromData", + "type" : "function", "desc" : "Sets the value of the field based on a object which is related to the record format for the store.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -732,15 +687,20 @@ }, { "name" : "selectByValue", + "type" : "function", "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "sig" : "(value, scrollIntoView)", + "static" : false, + "memberOf" : "Roo.form.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -765,15 +725,20 @@ }, { "name" : "setEditable", + "type" : "function", "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -786,43 +751,58 @@ }, { "name" : "collapse", + "type" : "function", "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "clearValue", + "type" : "function", "desc" : "Clears any text/value currently set in the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.ComboBox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onTriggerClick", + "type" : "function", "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.form.TriggerField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TriggerField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -835,29 +815,39 @@ }, { "name" : "autoSize", + "type" : "function", "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TriggerField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TriggerField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "selectText", + "type" : "function", "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "start", @@ -876,15 +866,20 @@ }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -903,29 +898,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -937,15 +942,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -957,15 +967,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -978,15 +993,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -998,15 +1018,20 @@ }, { "name" : "applyTo", + "type" : "function", "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -1025,43 +1050,58 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isDirty", + "type" : "function", "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -1074,29 +1114,39 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isValid", + "type" : "function", "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "preventMark", @@ -1115,29 +1165,39 @@ }, { "name" : "hasChanged", + "type" : "function", "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -1150,15 +1210,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -1177,29 +1242,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -1224,15 +1299,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -1251,15 +1331,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -1290,15 +1375,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -1311,15 +1401,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1331,15 +1426,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -1358,15 +1458,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -1385,15 +1490,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1405,15 +1515,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -1426,43 +1541,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -1475,15 +1605,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1495,15 +1630,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -1522,15 +1662,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1542,15 +1687,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1562,15 +1712,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1589,15 +1744,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1609,15 +1769,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1629,29 +1794,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1682,15 +1857,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1715,15 +1895,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1736,15 +1921,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1757,15 +1947,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1790,15 +1985,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1823,15 +2023,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1850,15 +2055,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1883,15 +2093,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1924,7 +2139,9 @@ "events" : [ { "name" : "add", + "type" : "function", "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)", + "sig" : "function (combo)\n{\n\n}", "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", @@ -1942,7 +2159,9 @@ }, { "name" : "expand", + "type" : "function", "desc" : "Fires when the dropdown list is expanded", + "sig" : "function (combo)\n{\n\n}", "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", @@ -1960,7 +2179,9 @@ }, { "name" : "collapse", + "type" : "function", "desc" : "Fires when the dropdown list is collapsed", + "sig" : "function (combo)\n{\n\n}", "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", @@ -1978,7 +2199,9 @@ }, { "name" : "select", + "type" : "function", "desc" : "Fires when a list item is selected", + "sig" : "function (combo, record, index)\n{\n\n}", "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", @@ -2008,7 +2231,9 @@ }, { "name" : "edit", + "type" : "function", "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)", + "sig" : "function (combo, record)\n{\n\n}", "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", @@ -2032,7 +2257,9 @@ }, { "name" : "beforequery", + "type" : "function", "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:", + "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}", "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", @@ -2074,7 +2301,9 @@ }, { "name" : "beforeselect", + "type" : "function", "desc" : "Fires before a list item is selected. Return false to cancel the selection.", + "sig" : "function (combo, record, index)\n{\n\n}", "memberOf" : "Roo.form.ComboBox", "example" : "", "deprecated" : "", @@ -2104,7 +2333,9 @@ }, { "name" : "autosize", + "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", @@ -2128,7 +2359,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2146,7 +2379,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2164,7 +2399,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2188,7 +2425,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2206,7 +2445,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2230,7 +2471,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2254,7 +2497,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2284,7 +2529,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -2314,7 +2561,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -2356,7 +2605,9 @@ }, { "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" : "", @@ -2374,7 +2625,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2392,7 +2645,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2410,7 +2665,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2428,7 +2685,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2446,7 +2705,9 @@ }, { "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" : "", @@ -2464,7 +2725,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2482,7 +2745,9 @@ }, { "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" : "", @@ -2500,7 +2765,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2518,7 +2785,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.DateField.json b/docs/symbols/Roo.form.DateField.json index eaea75592f..acd3b1ae80 100644 --- a/docs/symbols/Roo.form.DateField.json +++ b/docs/symbols/Roo.form.DateField.json @@ -26,401 +26,351 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "triggerClass", "type" : "String", "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be appended if specified (defaults to 'x-form-date-trigger'\nwhich displays a calendar icon).", - "memberOf" : "Roo.form.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "useIso", "type" : "Boolean", "desc" : "if enabled, then the date field will use a hidden field to store the \nreal value as iso formated date. default (false)", - "memberOf" : "Roo.form.DateField", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to disable the field (defaults to false).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "name", "type" : "String", "desc" : "The field's HTML name attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "disabledDates", "type" : "Array", "desc" : "An array of \"dates\" to disable, as strings. These strings will be used to build a dynamic regular\nexpression so they are very powerful. Some examples:\n
    \n
  • [\"03/08/2003\", \"09/16/2003\"] would disable those exact dates
  • \n
  • [\"03/08\", \"09/16\"] would disable those days for every year
  • \n
  • [\"^03/08\"] would only match the beginning (useful if you are using short years)
  • \n
  • [\"03/../2006\"] would disable every day in March 2006
  • \n
  • [\"^03\"] would disable every day in every March
  • \n
\nIn order to support regular expressions, if you are using a date format that has \".\" in it, you will have to\nescape the dot when restricting dates. For example: [\"03\\\\.08\\\\.03\"].", - "memberOf" : "Roo.form.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "width", "type" : "Number", "desc" : "width (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "regexText", "type" : "String", "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "altFormats", "type" : "String", "desc" : "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').", - "memberOf" : "Roo.form.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "maxValue", "type" : "Date/String", "desc" : "The maximum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).", - "memberOf" : "Roo.form.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "minValue", "type" : "Date/String", "desc" : "The minimum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).", - "memberOf" : "Roo.form.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "height", "type" : "Number", "desc" : "height (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "disabledDaysText", "type" : "String", "desc" : "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')", - "memberOf" : "Roo.form.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "minText", "type" : "String", "desc" : "The error text to display when the date in the cell is before minValue (defaults to\n'The date in this field must be after {minValue}').", - "memberOf" : "Roo.form.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "emptyText", "type" : "String", "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "value", "type" : "Mixed", "desc" : "A value to initialize this field with.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "msgFx", "type" : "String", "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "msgTarget", "type" : "String", "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "disabledDatesText", "type" : "String", "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')", - "memberOf" : "Roo.form.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "disabledDays", "type" : "Array", "desc" : "An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).", - "memberOf" : "Roo.form.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "hideTrigger", "type" : "Boolean", "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", - "memberOf" : "Roo.form.TriggerField", - "optvals" : [] + "memberOf" : "Roo.form.TriggerField" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the field's underlying element.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "inputType", "type" : "String", "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldClass", "type" : "String", "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "autoCreate", "type" : "String/Object", "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"10\", autocomplete: \"off\"})", - "memberOf" : "Roo.form.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowLeadingSpace", "type" : "Boolean", "desc" : "True to prevent the stripping of leading white space", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "invalidClass", "type" : "String", "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldLabel", "type" : "String", "desc" : "Label to use when rendering a form.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "format", "type" : "String", "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').", - "memberOf" : "Roo.form.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "maxText", "type" : "String", "desc" : "The error text to display when the date in the cell is after maxValue (defaults to\n'The date in this field must be before {maxValue}').", - "memberOf" : "Roo.form.DateField", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "qtip", "type" : "String", "desc" : "Mouse over tip", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to display when the date in the field is invalid (defaults to\n'{value} is not a valid date - it must be in the format {format}').", - "memberOf" : "Roo.form.DateField", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "getValue", + "type" : "function", "desc" : "Returns the current date value of the date field.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.DateField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -432,15 +382,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using DateField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n
Usage:\n
\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\ndateField.setValue(dt);\n\n//Pass a date string (default format):\ndateField.setValue('5/4/06');\n\n//Pass a date string (custom format):\ndateField.format = 'Y-m-d';\ndateField.setValue('2006-5-4');\n
", + "sig" : "(date)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.DateField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "date", @@ -453,15 +408,20 @@ }, { "name" : "onTriggerClick", + "type" : "function", "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.form.TriggerField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TriggerField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -474,29 +434,39 @@ }, { "name" : "autoSize", + "type" : "function", "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TriggerField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TriggerField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "selectText", + "type" : "function", "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "start", @@ -515,15 +485,20 @@ }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -542,29 +517,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -576,15 +561,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -596,15 +586,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -617,15 +612,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -637,15 +637,20 @@ }, { "name" : "applyTo", + "type" : "function", "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -664,43 +669,58 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isDirty", + "type" : "function", "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -713,29 +733,39 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isValid", + "type" : "function", "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "preventMark", @@ -754,29 +784,39 @@ }, { "name" : "hasChanged", + "type" : "function", "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -789,15 +829,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -816,29 +861,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -863,15 +918,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -890,15 +950,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -929,15 +994,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -950,15 +1020,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -970,15 +1045,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -997,15 +1077,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -1024,15 +1109,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1044,15 +1134,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -1065,43 +1160,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -1114,15 +1224,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1134,15 +1249,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -1161,15 +1281,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1181,15 +1306,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1201,15 +1331,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1228,15 +1363,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1248,15 +1388,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1268,29 +1413,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1321,15 +1476,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1354,15 +1514,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1375,15 +1540,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1396,15 +1566,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1429,15 +1604,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1462,15 +1642,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1489,15 +1674,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1522,15 +1712,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1563,8 +1758,10 @@ "events" : [ { "name" : "select", + "type" : "function", "desc" : "Fires when a date is selected", - "memberOf" : "Roo.form.DateField", + "sig" : "function (combo, date)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1587,7 +1784,9 @@ }, { "name" : "autosize", + "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", @@ -1611,7 +1810,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1629,7 +1830,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1647,7 +1850,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1671,7 +1876,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1689,7 +1896,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1713,7 +1922,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1737,7 +1948,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1767,7 +1980,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1797,7 +2012,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1839,7 +2056,9 @@ }, { "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" : "", @@ -1857,7 +2076,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1875,7 +2096,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1893,7 +2116,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1911,7 +2136,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1929,7 +2156,9 @@ }, { "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" : "", @@ -1947,7 +2176,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1965,7 +2196,9 @@ }, { "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" : "", @@ -1983,7 +2216,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2001,7 +2236,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.DayPicker.json b/docs/symbols/Roo.form.DayPicker.json index 6aaccec2ac..880458cb03 100644 --- a/docs/symbols/Roo.form.DayPicker.json +++ b/docs/symbols/Roo.form.DayPicker.json @@ -24,205 +24,183 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "inputType", "type" : "String", "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "msgFx", "type" : "String", "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldLabel", "type" : "String", "desc" : "Label to use when rendering a form.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "msgTarget", "type" : "String", "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to disable the field (defaults to false).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "value", "type" : "Mixed", "desc" : "A value to initialize this field with.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "invalidClass", "type" : "String", "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the field's underlying element.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "autoCreate", "type" : "String/Object", "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})", - "memberOf" : "Roo.form.DayPicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "width", "type" : "Number", "desc" : "width (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldClass", "type" : "String", "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")", - "memberOf" : "Roo.form.DayPicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)", - "memberOf" : "Roo.form.DayPicker", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "String", "desc" : "The field's HTML name attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "qtip", "type" : "String", "desc" : "Mouse over tip", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "height", "type" : "Number", "desc" : "height (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "getValue", + "type" : "function", "desc" : "Returns the checked state of the checkbox.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.DayPicker", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -234,15 +212,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.", + "sig" : "(value, suppressEvent)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.DayPicker", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -261,15 +244,20 @@ }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -281,15 +269,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -301,15 +294,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -322,15 +320,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -342,15 +345,20 @@ }, { "name" : "applyTo", + "type" : "function", "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -369,43 +377,58 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isDirty", + "type" : "function", "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -418,29 +441,39 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isValid", + "type" : "function", "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "preventMark", @@ -459,43 +492,58 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "hasChanged", + "type" : "function", "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -508,15 +556,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -535,29 +588,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -582,15 +645,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -609,15 +677,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -648,15 +721,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -669,15 +747,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -689,15 +772,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -716,15 +804,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -743,15 +836,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -763,15 +861,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -784,43 +887,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -833,15 +951,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -853,15 +976,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -880,15 +1008,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -900,15 +1033,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -920,15 +1058,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -947,15 +1090,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -967,15 +1115,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -987,29 +1140,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1040,15 +1203,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1073,15 +1241,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1094,15 +1267,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1115,15 +1293,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1148,15 +1331,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1181,15 +1369,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1208,15 +1401,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1241,15 +1439,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1282,7 +1485,9 @@ "events" : [ { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1300,7 +1505,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1318,7 +1525,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1342,7 +1551,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1360,7 +1571,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1384,7 +1597,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1408,7 +1623,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1438,7 +1655,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1468,7 +1687,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1510,7 +1731,9 @@ }, { "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" : "", @@ -1528,7 +1751,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1546,7 +1771,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1564,7 +1791,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1582,7 +1811,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1600,7 +1831,9 @@ }, { "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" : "", @@ -1618,7 +1851,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1636,7 +1871,9 @@ }, { "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" : "", @@ -1654,7 +1891,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1672,7 +1911,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.DisplayField.json b/docs/symbols/Roo.form.DisplayField.json index c6bccf2b18..c1a447be61 100644 --- a/docs/symbols/Roo.form.DisplayField.json +++ b/docs/symbols/Roo.form.DisplayField.json @@ -24,222 +24,195 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "inputType", "type" : "String", "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "msgFx", "type" : "String", "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "valueRenderer", "type" : "Function", "desc" : "The renderer for the field (so you can reformat output). should return raw HTML", - "memberOf" : "Roo.form.DisplayField", - "optvals" : [] + "memberOf" : "" }, { "name" : "fieldLabel", "type" : "String", "desc" : "Label to use when rendering a form.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "msgTarget", "type" : "String", "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to disable the field (defaults to false).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "value", "type" : "Mixed", "desc" : "A value to initialize this field with.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "invalidClass", "type" : "String", "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the field's underlying element.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "autoCreate", "type" : "String/Object", "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})", - "memberOf" : "Roo.form.DisplayField", - "optvals" : [] + "memberOf" : "" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "width", "type" : "Number", "desc" : "width (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "closable", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.form.DisplayField", - "optvals" : [ - "true", - "false" - ] + "memberOf" : "" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldClass", "type" : "String", "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")", - "memberOf" : "Roo.form.DisplayField", - "optvals" : [] + "memberOf" : "" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)", - "memberOf" : "Roo.form.DisplayField", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "String", "desc" : "The field's HTML name attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "qtip", "type" : "String", "desc" : "Mouse over tip", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "height", "type" : "Number", "desc" : "height (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "setValue", + "type" : "function", "desc" : "Sets the checked state of the checkbox.", + "sig" : "(checked)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.DisplayField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "checked", @@ -252,15 +225,20 @@ }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -272,15 +250,20 @@ }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -292,15 +275,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -312,15 +300,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -333,15 +326,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -353,15 +351,20 @@ }, { "name" : "applyTo", + "type" : "function", "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -380,43 +383,58 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isDirty", + "type" : "function", "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -429,29 +447,39 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isValid", + "type" : "function", "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "preventMark", @@ -470,43 +498,58 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "hasChanged", + "type" : "function", "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -519,15 +562,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -546,29 +594,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -593,15 +651,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -620,15 +683,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -659,15 +727,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -680,15 +753,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -700,15 +778,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -727,15 +810,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -754,15 +842,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -774,15 +867,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -795,43 +893,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -844,15 +957,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -864,15 +982,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -891,15 +1014,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -911,15 +1039,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -931,15 +1064,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -958,15 +1096,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -978,15 +1121,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -998,29 +1146,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1051,15 +1209,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1084,15 +1247,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1105,15 +1273,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1126,15 +1299,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1159,15 +1337,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1192,15 +1375,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1219,15 +1407,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1252,15 +1445,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1293,8 +1491,10 @@ "events" : [ { "name" : "close", + "type" : "function", "desc" : "Fires after the click the close btn", - "memberOf" : "Roo.form.DisplayField", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1311,7 +1511,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1329,7 +1531,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1347,7 +1551,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1371,7 +1577,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1389,7 +1597,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1413,7 +1623,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1437,7 +1649,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1467,7 +1681,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1497,7 +1713,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1539,7 +1757,9 @@ }, { "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" : "", @@ -1557,7 +1777,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1575,7 +1797,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1593,7 +1817,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1611,7 +1837,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1629,7 +1857,9 @@ }, { "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" : "", @@ -1647,7 +1877,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1665,7 +1897,9 @@ }, { "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" : "", @@ -1683,7 +1917,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1701,7 +1937,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.FCKeditor.json b/docs/symbols/Roo.form.FCKeditor.json index dd8bfd8dec..f731e09e61 100644 --- a/docs/symbols/Roo.form.FCKeditor.json +++ b/docs/symbols/Roo.form.FCKeditor.json @@ -26,345 +26,303 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to disable the field (defaults to false).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "name", "type" : "String", "desc" : "The field's HTML name attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "width", "type" : "Number", "desc" : "width (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "regexText", "type" : "String", "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "height", "type" : "Number", "desc" : "height (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "emptyText", "type" : "String", "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "value", "type" : "Mixed", "desc" : "A value to initialize this field with.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "msgFx", "type" : "String", "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "msgTarget", "type" : "String", "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "preventScrollbars", "type" : "Boolean", "desc" : "True to prevent scrollbars from appearing regardless of how much text is\nin the field (equivalent to setting overflow: hidden, defaults to false)", - "memberOf" : "Roo.form.TextArea", - "optvals" : [] + "memberOf" : "Roo.form.TextArea" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the field's underlying element.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldClass", "type" : "String", "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fck", "type" : "Object", "desc" : "BasePath", - "memberOf" : "Roo.form.FCKeditor", - "optvals" : [] + "memberOf" : "" }, { "name" : "inputType", "type" : "String", "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "allowLeadingSpace", "type" : "Boolean", "desc" : "True to prevent the stripping of leading white space", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "autoCreate", "type" : "String/Object", "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"textarea\", style: \"width:300px;height:60px;\", autocomplete: \"off\"})", - "memberOf" : "Roo.form.TextArea", - "optvals" : [] + "memberOf" : "Roo.form.TextArea" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "invalidClass", "type" : "String", "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "growMin", "type" : "Number", "desc" : "The minimum height to allow when grow = true (defaults to 60)", - "memberOf" : "Roo.form.TextArea", - "optvals" : [] + "memberOf" : "Roo.form.TextArea" }, { "name" : "fieldLabel", "type" : "String", "desc" : "Label to use when rendering a form.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "growMax", "type" : "Number", "desc" : "The maximum height to allow when grow = true (defaults to 1000)", - "memberOf" : "Roo.form.TextArea", - "optvals" : [] + "memberOf" : "Roo.form.TextArea" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "grow", "type" : "Boolean", "desc" : "True if this field should automatically grow and shrink to its content", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "qtip", "type" : "String", "desc" : "Mouse over tip", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" } ], "methods" : [ { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.FCKeditor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -376,15 +334,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.FCKeditor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -396,15 +359,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.FCKeditor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -417,29 +385,39 @@ }, { "name" : "autoSize", + "type" : "function", "desc" : "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextArea", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextArea", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "selectText", + "type" : "function", "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "start", @@ -458,15 +436,20 @@ }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -485,29 +468,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -519,15 +512,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -539,15 +537,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -560,15 +563,20 @@ }, { "name" : "applyTo", + "type" : "function", "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -587,43 +595,58 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isDirty", + "type" : "function", "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -636,29 +659,39 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isValid", + "type" : "function", "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "preventMark", @@ -677,29 +710,39 @@ }, { "name" : "hasChanged", + "type" : "function", "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -712,15 +755,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -739,29 +787,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -786,15 +844,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -813,15 +876,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -852,15 +920,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -873,15 +946,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -893,15 +971,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -920,15 +1003,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -947,15 +1035,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -967,15 +1060,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -988,43 +1086,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -1037,15 +1150,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1057,15 +1175,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -1084,15 +1207,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1104,15 +1232,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1124,15 +1257,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1151,15 +1289,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1171,15 +1314,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1191,29 +1339,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1244,15 +1402,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1277,15 +1440,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1298,15 +1466,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1319,15 +1492,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1352,15 +1530,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1385,15 +1568,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1412,15 +1600,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1445,15 +1638,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1486,8 +1684,10 @@ "events" : [ { "name" : "editorinit", + "type" : "function", "desc" : "Fired when the editor is initialized - you can add extra handlers here..", - "memberOf" : "Roo.form.FCKeditor", + "sig" : "function (_self, the)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1510,7 +1710,9 @@ }, { "name" : "autosize", + "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", @@ -1534,7 +1736,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1552,7 +1756,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1570,7 +1776,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1594,7 +1802,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1612,7 +1822,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1636,7 +1848,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1660,7 +1874,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1690,7 +1906,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1720,7 +1938,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1762,7 +1982,9 @@ }, { "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" : "", @@ -1780,7 +2002,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1798,7 +2022,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1816,7 +2042,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1834,7 +2062,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1852,7 +2082,9 @@ }, { "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" : "", @@ -1870,7 +2102,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1888,7 +2122,9 @@ }, { "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" : "", @@ -1906,7 +2142,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1924,7 +2162,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.Field.json b/docs/symbols/Roo.form.Field.json index 87fc9c6811..1fab307f6b 100644 --- a/docs/symbols/Roo.form.Field.json +++ b/docs/symbols/Roo.form.Field.json @@ -23,205 +23,183 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "inputType", "type" : "String", "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "msgFx", "type" : "String", "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "" }, { "name" : "fieldLabel", "type" : "String", "desc" : "Label to use when rendering a form.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "" }, { "name" : "msgTarget", "type" : "String", "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to disable the field (defaults to false).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "" }, { "name" : "value", "type" : "Mixed", "desc" : "A value to initialize this field with.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "" }, { "name" : "invalidClass", "type" : "String", "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the field's underlying element.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "" }, { "name" : "autoCreate", "type" : "String/Object", "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "width", "type" : "Number", "desc" : "width (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "String", "desc" : "The field's HTML name attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "" }, { "name" : "qtip", "type" : "String", "desc" : "Mouse over tip", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "" }, { "name" : "fieldClass", "type" : "String", "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "" }, { "name" : "height", "type" : "Number", "desc" : "height (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -233,15 +211,20 @@ }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -253,15 +236,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -274,15 +262,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -294,15 +287,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -315,15 +313,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -335,15 +338,20 @@ }, { "name" : "applyTo", + "type" : "function", "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -362,43 +370,58 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isDirty", + "type" : "function", "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -411,29 +434,39 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isValid", + "type" : "function", "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "preventMark", @@ -452,43 +485,58 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "hasChanged", + "type" : "function", "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -501,15 +549,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -528,29 +581,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -575,15 +638,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -602,15 +670,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -641,15 +714,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -662,15 +740,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -682,15 +765,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -709,15 +797,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -736,15 +829,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -756,15 +854,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -777,43 +880,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -826,15 +944,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -846,15 +969,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -873,15 +1001,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -893,15 +1026,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -913,15 +1051,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -940,15 +1083,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -960,15 +1108,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -980,29 +1133,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1033,15 +1196,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1066,15 +1234,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1087,15 +1260,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1108,15 +1286,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1141,15 +1324,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1174,15 +1362,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1201,15 +1394,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1234,15 +1432,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1275,8 +1478,10 @@ "events" : [ { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", - "memberOf" : "Roo.form.Field", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1293,8 +1498,10 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", - "memberOf" : "Roo.form.Field", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1311,8 +1518,10 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", - "memberOf" : "Roo.form.Field", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1335,8 +1544,10 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", - "memberOf" : "Roo.form.Field", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1353,8 +1564,10 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", - "memberOf" : "Roo.form.Field", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1377,8 +1590,10 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", - "memberOf" : "Roo.form.Field", + "sig" : "function (_self, msg)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1401,8 +1616,10 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", - "memberOf" : "Roo.form.Field", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1431,7 +1648,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1461,7 +1680,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1503,7 +1724,9 @@ }, { "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" : "", @@ -1521,7 +1744,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1539,7 +1764,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1557,7 +1784,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1575,7 +1804,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1593,7 +1824,9 @@ }, { "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" : "", @@ -1611,7 +1844,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1629,7 +1864,9 @@ }, { "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" : "", @@ -1647,7 +1884,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1665,7 +1904,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.FieldSet.json b/docs/symbols/Roo.form.FieldSet.json index d7ac6eadc1..aab3b38592 100644 --- a/docs/symbols/Roo.form.FieldSet.json +++ b/docs/symbols/Roo.form.FieldSet.json @@ -23,114 +23,105 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "labelAlign", "type" : "String", "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "Roo.form.Layout" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "hideLabels", "type" : "Boolean", "desc" : "True to suppress the display of field labels in this layout (defaults to false)", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "Roo.form.Layout" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "legend", "type" : "String", "desc" : "The text to display as the legend for the FieldSet (defaults to '')", - "memberOf" : "Roo.form.FieldSet", - "optvals" : [] + "memberOf" : "" }, { "name" : "style", "type" : "String/Object/Function", "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "Roo.form.Layout" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "labelWidth", "type" : "Number", "desc" : "Fixed width in pixels of all field labels (defaults to undefined)", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "Roo.form.Layout" }, { "name" : "labelSeparator", "type" : "String", "desc" : "The separator to use after field labels (defaults to ':')", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "Roo.form.Layout" }, { "name" : "autoCreate", "type" : "String/Object", "desc" : "A DomHelper element spec used to autocreate the fieldset (defaults to {tag: 'fieldset', cn: {tag:'legend'}})", - "memberOf" : "Roo.form.FieldSet", - "optvals" : [] + "memberOf" : "" }, { "name" : "clear", "type" : "Boolean", "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "Roo.form.Layout" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "addxtype", + "type" : "function", "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column", + "sig" : "(config)", + "static" : false, + "memberOf" : "Roo.form.Layout", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Layout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -143,15 +134,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -163,15 +159,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -184,43 +185,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -233,15 +249,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -253,15 +274,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -280,15 +306,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -300,15 +331,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -320,15 +356,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -347,15 +388,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -367,15 +413,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -387,29 +438,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -440,15 +501,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -473,15 +539,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -494,15 +565,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -515,15 +591,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -548,15 +629,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -581,15 +667,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -608,15 +699,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -641,15 +737,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -682,7 +783,9 @@ "events" : [ { "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" : "", @@ -700,7 +803,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -718,7 +823,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -736,7 +843,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -754,7 +863,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -772,7 +883,9 @@ }, { "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" : "", @@ -790,7 +903,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -808,7 +923,9 @@ }, { "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" : "", @@ -826,7 +943,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -844,7 +963,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.Form.json b/docs/symbols/Roo.form.Form.json index 1d3d6b09f5..ebc3d83afb 100644 --- a/docs/symbols/Roo.form.Form.json +++ b/docs/symbols/Roo.form.Form.json @@ -22,163 +22,153 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "labelAlign", "type" : "String", "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\").\nThis property cascades to child containers if not set.", - "memberOf" : "Roo.form.Form", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "formData", "type" : "boolean|FormData", "desc" : "- true to use new 'FormData' post, or set to a new FormData({dom form}) Object, if\nsending a formdata with extra parameters - eg uploaded elements.", - "memberOf" : "Roo.form.Form", - "optvals" : [] + "memberOf" : "" }, { "name" : "monitorValid", "type" : "Boolean", "desc" : "If true the form monitors its valid state client-side and\nfires a looping event with that state. This is required to bind buttons to the valid\nstate using the config value formBind:true on the button.", - "memberOf" : "Roo.form.Form", - "optvals" : [] + "memberOf" : "" }, { "name" : "fileUpload", "type" : "Boolean", "desc" : "Set to true if this form is a file upload.", - "memberOf" : "Roo.form.BasicForm", - "optvals" : [] + "memberOf" : "Roo.form.BasicForm" }, { "name" : "progressUrl", "type" : "String", "desc" : "- Url to return progress data", - "memberOf" : "Roo.form.Form", - "optvals" : [] + "memberOf" : "" + }, + { + "name" : "buttons[]", + "type" : "Roo.Button", + "desc" : "buttons at bottom of form", + "memberOf" : "" }, { "name" : "minButtonWidth", "type" : "Number", "desc" : "Minimum width of all buttons in pixels (defaults to 75)", - "memberOf" : "Roo.form.Form", - "optvals" : [] + "memberOf" : "" }, { "name" : "buttonAlign", "type" : "String", "desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"center\")", - "memberOf" : "Roo.form.Form", - "optvals" : [] + "memberOf" : "" }, { "name" : "method", "type" : "String", "desc" : "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.", - "memberOf" : "Roo.form.BasicForm", - "optvals" : [] + "memberOf" : "Roo.form.BasicForm" }, { "name" : "errorMask", "type" : "Boolean", "desc" : "e) default false", - "memberOf" : "Roo.form.BasicForm", - "optvals" : [ - "true", - "false" - ] - }, - { - "name" : "labelWidth", - "type" : "Number", - "desc" : "The width of labels. This property cascades to child containers.", - "memberOf" : "Roo.form.Form", - "optvals" : [] + "memberOf" : "Roo.form.BasicForm" }, { "name" : "itemCls", "type" : "String", "desc" : "A css class to apply to the x-form-item of fields. This property cascades to child containers.", - "memberOf" : "Roo.form.Form", - "optvals" : [] + "memberOf" : "" + }, + { + "name" : "labelWidth", + "type" : "Number", + "desc" : "The width of labels. This property cascades to child containers.", + "memberOf" : "" }, { "name" : "timeout", "type" : "Number", "desc" : "Timeout for form actions in seconds (default is 30 seconds).", - "memberOf" : "Roo.form.BasicForm", - "optvals" : [] + "memberOf" : "Roo.form.BasicForm" }, { "name" : "monitorPoll", "type" : "Number", "desc" : "The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)", - "memberOf" : "Roo.form.Form", - "optvals" : [] + "memberOf" : "" }, { "name" : "baseParams", "type" : "Object", "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.", - "memberOf" : "Roo.form.BasicForm", - "optvals" : [] + "memberOf" : "Roo.form.BasicForm" }, { "name" : "trackResetOnLoad", "type" : "Boolean", "desc" : "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.", - "memberOf" : "Roo.form.BasicForm", - "optvals" : [] + "memberOf" : "Roo.form.BasicForm" }, { "name" : "reader", "type" : "DataReader", "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.", - "memberOf" : "Roo.form.BasicForm", - "optvals" : [] + "memberOf" : "Roo.form.BasicForm" }, { "name" : "errorReader", "type" : "DataReader", "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on \"submit\" actions.\nThis is completely optional as there is built-in support for processing JSON.", - "memberOf" : "Roo.form.BasicForm", - "optvals" : [] + "memberOf" : "Roo.form.BasicForm" }, { "name" : "url", "type" : "String", "desc" : "The URL to use for form actions if one isn't supplied in the action options.", - "memberOf" : "Roo.form.BasicForm", - "optvals" : [] + "memberOf" : "Roo.form.BasicForm" }, { "name" : "maskOffset", "type" : "Number", "desc" : "Default 100", - "memberOf" : "Roo.form.BasicForm", - "optvals" : [] + "memberOf" : "Roo.form.BasicForm" } ], "methods" : [ { "name" : "addxtype", + "type" : "function", "desc" : "Adds a series of form elements (using the xtype property as the factory method.\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column, (and 'end' to close a block)", + "sig" : "(config)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Form", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -191,15 +181,20 @@ }, { "name" : "fieldset", + "type" : "function", "desc" : "Opens a new {@link Roo.form.FieldSet} container in the layout stack. If fields are passed after the config, the\nfields are added and the fieldset is closed. If no fields are passed the fieldset remains open\nuntil end() is called.", + "sig" : "(config, field1, field2, etc)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Form", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -236,15 +231,20 @@ }, { "name" : "start", + "type" : "function", "desc" : "Opens the passed container in the layout stack. The container can be any {@link Roo.form.Layout} or subclass.", + "sig" : "(container)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Form", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -263,15 +263,20 @@ }, { "name" : "container", + "type" : "function", "desc" : "Opens a new {@link Roo.form.Layout} container in the layout stack. If fields are passed after the config, the\nfields are added and the container is closed. If no fields are passed the container remains open\nuntil end() is called.", + "sig" : "(config, field1, field2, etc)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Form", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -308,15 +313,20 @@ }, { "name" : "render", + "type" : "function", "desc" : "Render this form into the passed container. This should only be called once!", + "sig" : "(container)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Form", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -335,29 +345,39 @@ }, { "name" : "startMonitoring", + "type" : "function", "desc" : "Starts monitoring of the valid state of this form. Usually this is done by passing the config\noption \"monitorValid\"", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Form", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "addButton", + "type" : "function", "desc" : "Adds a button to the footer of the form - this must be called before the form is rendered.", + "sig" : "(config, handler, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Form", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -388,29 +408,39 @@ }, { "name" : "stopMonitoring", + "type" : "function", "desc" : "Stops monitoring of the valid state of this form", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Form", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "add", + "type" : "function", "desc" : "Add Roo.form components to the current open container (e.g. column, fieldset, etc.). Fields added via this method\ncan also be passed with an additional property of fieldLabel, which if supplied, will provide the text to display\nas the label of the field.", + "sig" : "(field1, field2)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Form", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "field1", @@ -435,15 +465,20 @@ }, { "name" : "findbyId", + "type" : "function", "desc" : "Find any element that has been added to a form, using it's ID or name\nThis can include framesets, columns etc. along with regular fields..", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Form", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -462,15 +497,20 @@ }, { "name" : "column", + "type" : "function", "desc" : "Opens a new {@link Roo.form.Column} container in the layout stack. If fields are passed after the config, the\nfields are added and the column is closed. If no fields are passed the column remains open\nuntil end() is called.", + "sig" : "(config, field1, field2, etc)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Form", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -507,15 +547,20 @@ }, { "name" : "end", + "type" : "function", "desc" : "Closes the current open container", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Form", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -527,15 +572,20 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Removes a field from the items collection (does NOT remove its markup).", + "sig" : "(field)", + "static" : false, + "memberOf" : "Roo.form.BasicForm", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "field", @@ -554,15 +604,20 @@ }, { "name" : "loadRecord", + "type" : "function", "desc" : "Loads an Roo.data.Record into this form.", + "sig" : "(record)", + "static" : false, + "memberOf" : "Roo.form.BasicForm", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "record", @@ -581,15 +636,20 @@ }, { "name" : "load", + "type" : "function", "desc" : "Shortcut to do a load action.", + "sig" : "(options)", + "static" : false, + "memberOf" : "Roo.form.BasicForm", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "options", @@ -608,15 +668,20 @@ }, { "name" : "doAction", + "type" : "function", "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.", + "sig" : "(actionName, options)", + "static" : false, + "memberOf" : "Roo.form.BasicForm", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "actionName", @@ -641,15 +706,20 @@ }, { "name" : "getValues", + "type" : "function", "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.", + "sig" : "(asString)", + "static" : false, + "memberOf" : "Roo.form.BasicForm", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "asString", @@ -668,15 +738,20 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.BasicForm", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -688,15 +763,20 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clears all invalid messages in this form.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.BasicForm", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -708,15 +788,20 @@ }, { "name" : "isDirty", + "type" : "function", "desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.BasicForm", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -728,15 +813,20 @@ }, { "name" : "updateRecord", + "type" : "function", "desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.", + "sig" : "(record)", + "static" : false, + "memberOf" : "Roo.form.BasicForm", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "record", @@ -755,15 +845,20 @@ }, { "name" : "hasChanged", + "type" : "function", "desc" : "Returns true if any fields in this form have changed since their original load. (New version)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.BasicForm", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -775,15 +870,20 @@ }, { "name" : "applyToFields", + "type" : "function", "desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.", + "sig" : "(values)", + "static" : false, + "memberOf" : "Roo.form.BasicForm", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "values", @@ -802,15 +902,20 @@ }, { "name" : "getFieldValues", + "type" : "function", "desc" : "Returns the fields in this form as an object with key/value pairs. \nThis differs from getValues as it calls getValue on each child item, rather than using dom data.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.BasicForm", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -822,15 +927,20 @@ }, { "name" : "submit", + "type" : "function", "desc" : "Shortcut to do a submit action.", + "sig" : "(options)", + "static" : false, + "memberOf" : "Roo.form.BasicForm", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "options", @@ -849,15 +959,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark fields in this form invalid in bulk.", + "sig" : "(errors)", + "static" : false, + "memberOf" : "Roo.form.BasicForm", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "errors", @@ -876,15 +991,20 @@ }, { "name" : "setValues", + "type" : "function", "desc" : "Set values for fields in this form in bulk.", + "sig" : "(values)", + "static" : false, + "memberOf" : "Roo.form.BasicForm", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "values", @@ -903,15 +1023,20 @@ }, { "name" : "isValid", + "type" : "function", "desc" : "Returns true if client-side validation on the form is successful.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.BasicForm", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -923,15 +1048,20 @@ }, { "name" : "invalidFields", + "type" : "function", "desc" : "Returns array of invalid form fields.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.BasicForm", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -943,15 +1073,20 @@ }, { "name" : "applyIfToFields", + "type" : "function", "desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.", + "sig" : "(values)", + "static" : false, + "memberOf" : "Roo.form.BasicForm", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "values", @@ -970,15 +1105,20 @@ }, { "name" : "findField", + "type" : "function", "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.form.BasicForm", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -997,15 +1137,20 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets this form.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.BasicForm", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1017,15 +1162,20 @@ }, { "name" : "addForm", + "type" : "function", "desc" : "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms.", + "sig" : "(form)", + "static" : false, + "memberOf" : "Roo.form.BasicForm", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "form", @@ -1038,29 +1188,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1091,15 +1251,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1124,15 +1289,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1145,15 +1315,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1166,15 +1341,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1199,15 +1379,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1232,15 +1417,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1259,15 +1449,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1292,15 +1487,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1333,8 +1533,10 @@ "events" : [ { "name" : "rendered", + "type" : "function", "desc" : "Fires when the form is rendered", - "memberOf" : "Roo.form.Form", + "sig" : "function (form)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1351,8 +1553,10 @@ }, { "name" : "clientvalidation", + "type" : "function", "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state", - "memberOf" : "Roo.form.Form", + "sig" : "function (_self, valid)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1375,7 +1579,9 @@ }, { "name" : "beforeaction", + "type" : "function", "desc" : "Fires before any action is performed. Return false to cancel the action.", + "sig" : "function (_self, action)\n{\n\n}", "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", @@ -1399,7 +1605,9 @@ }, { "name" : "actioncomplete", + "type" : "function", "desc" : "Fires when an action is completed.", + "sig" : "function (_self, action)\n{\n\n}", "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", @@ -1423,7 +1631,9 @@ }, { "name" : "actionfailed", + "type" : "function", "desc" : "Fires when an action fails.", + "sig" : "function (_self, action)\n{\n\n}", "memberOf" : "Roo.form.BasicForm", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.form.GridField.json b/docs/symbols/Roo.form.GridField.json index cc31073a1a..aa13c93d68 100644 --- a/docs/symbols/Roo.form.GridField.json +++ b/docs/symbols/Roo.form.GridField.json @@ -24,219 +24,195 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "inputType", "type" : "String", "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "msgFx", "type" : "String", "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldLabel", "type" : "String", "desc" : "Label to use when rendering a form.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "xgrid", "type" : "Object", "desc" : "(xtype'd description of grid) { xtype : 'Grid', dataSource: .... }\n\n}", - "memberOf" : "Roo.form.GridField", - "optvals" : [] + "memberOf" : "" }, { "name" : "msgTarget", "type" : "String", "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to disable the field (defaults to false).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "value", "type" : "Mixed", "desc" : "A value to initialize this field with.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "invalidClass", "type" : "String", "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the field's underlying element.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "autoCreate", "type" : "String/Object", "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})", - "memberOf" : "Roo.form.GridField", - "optvals" : [] + "memberOf" : "" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "width", "type" : "Number", "desc" : "- used to restrict width of grid..", - "memberOf" : "Roo.form.GridField", - "optvals" : [] + "memberOf" : "" }, { "name" : "addTitle", "type" : "String", "desc" : "Text to include for adding a title.", - "memberOf" : "Roo.form.GridField", - "optvals" : [] + "memberOf" : "" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "height", "type" : "Number", "desc" : "- used to restrict height of grid..", - "memberOf" : "Roo.form.GridField", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "String", "desc" : "The field's HTML name attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "qtip", "type" : "String", "desc" : "Mouse over tip", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldClass", "type" : "String", "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "setValue", + "type" : "function", "desc" : "Sets the value of the item.", + "sig" : "(either)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.GridField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "either", @@ -249,15 +225,20 @@ }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -269,15 +250,20 @@ }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -289,15 +275,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -309,15 +300,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -330,15 +326,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -350,15 +351,20 @@ }, { "name" : "applyTo", + "type" : "function", "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -377,43 +383,58 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isDirty", + "type" : "function", "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -426,29 +447,39 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isValid", + "type" : "function", "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "preventMark", @@ -467,43 +498,58 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "hasChanged", + "type" : "function", "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -516,15 +562,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -543,29 +594,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -590,15 +651,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -617,15 +683,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -656,15 +727,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -677,15 +753,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -697,15 +778,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -724,15 +810,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -751,15 +842,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -771,15 +867,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -792,43 +893,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -841,15 +957,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -861,15 +982,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -888,15 +1014,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -908,15 +1039,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -928,15 +1064,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -955,15 +1096,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -975,15 +1121,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -995,29 +1146,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1048,15 +1209,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1081,15 +1247,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1102,15 +1273,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1123,15 +1299,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1156,15 +1337,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1189,15 +1375,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1216,15 +1407,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1249,15 +1445,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1290,7 +1491,9 @@ "events" : [ { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1308,7 +1511,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1326,7 +1531,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1350,7 +1557,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1368,7 +1577,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1392,7 +1603,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1416,7 +1629,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1446,7 +1661,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1476,7 +1693,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1518,7 +1737,9 @@ }, { "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" : "", @@ -1536,7 +1757,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1554,7 +1777,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1572,7 +1797,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1590,7 +1817,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1608,7 +1837,9 @@ }, { "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" : "", @@ -1626,7 +1857,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1644,7 +1877,9 @@ }, { "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" : "", @@ -1662,7 +1897,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1680,7 +1917,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.Hidden.json b/docs/symbols/Roo.form.Hidden.json index 7360f5cd2a..6fe217cde6 100644 --- a/docs/symbols/Roo.form.Hidden.json +++ b/docs/symbols/Roo.form.Hidden.json @@ -25,331 +25,291 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to disable the field (defaults to false).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "name", "type" : "String", "desc" : "The field's HTML name attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "width", "type" : "Number", "desc" : "width (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "regexText", "type" : "String", "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "height", "type" : "Number", "desc" : "height (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "value", "type" : "Mixed", "desc" : "A value to initialize this field with.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "emptyText", "type" : "String", "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "msgFx", "type" : "String", "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "msgTarget", "type" : "String", "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the field's underlying element.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "inputType", "type" : "String", "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldClass", "type" : "String", "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "allowLeadingSpace", "type" : "Boolean", "desc" : "True to prevent the stripping of leading white space", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "autoCreate", "type" : "String/Object", "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "invalidClass", "type" : "String", "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "growMin", "type" : "Number", "desc" : "The minimum width to allow when grow = true (defaults to 30)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldLabel", "type" : "String", "desc" : "Label to use when rendering a form.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "growMax", "type" : "Number", "desc" : "The maximum width to allow when grow = true (defaults to 800)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "grow", "type" : "Boolean", "desc" : "True if this field should automatically grow and shrink to its content", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "qtip", "type" : "String", "desc" : "Mouse over tip", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" } ], "methods" : [ { "name" : "selectText", + "type" : "function", "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "start", @@ -368,15 +328,20 @@ }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -395,43 +360,58 @@ }, { "name" : "autoSize", + "type" : "function", "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -443,15 +423,20 @@ }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -463,15 +448,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -484,15 +474,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -504,15 +499,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -525,15 +525,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -545,15 +550,20 @@ }, { "name" : "applyTo", + "type" : "function", "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -572,43 +582,58 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isDirty", + "type" : "function", "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -621,29 +646,39 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isValid", + "type" : "function", "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "preventMark", @@ -662,29 +697,39 @@ }, { "name" : "hasChanged", + "type" : "function", "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -697,15 +742,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -724,29 +774,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -771,15 +831,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -798,15 +863,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -837,15 +907,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -858,15 +933,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -878,15 +958,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -905,15 +990,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -932,15 +1022,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -952,15 +1047,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -973,43 +1073,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -1022,15 +1137,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1042,15 +1162,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -1069,15 +1194,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1089,15 +1219,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1109,15 +1244,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1136,15 +1276,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1156,15 +1301,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1176,29 +1326,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1229,15 +1389,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1262,15 +1427,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1283,15 +1453,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1304,15 +1479,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1337,15 +1517,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1370,15 +1555,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1397,15 +1587,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1430,15 +1625,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1471,7 +1671,9 @@ "events" : [ { "name" : "autosize", + "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", @@ -1495,7 +1697,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1513,7 +1717,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1531,7 +1737,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1555,7 +1763,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1573,7 +1783,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1597,7 +1809,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1621,7 +1835,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1651,7 +1867,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1681,7 +1899,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1723,7 +1943,9 @@ }, { "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" : "", @@ -1741,7 +1963,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1759,7 +1983,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1777,7 +2003,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1795,7 +2023,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1813,7 +2043,9 @@ }, { "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" : "", @@ -1831,7 +2063,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1849,7 +2083,9 @@ }, { "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" : "", @@ -1867,7 +2103,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1885,7 +2123,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.HtmlEditor.ToolbarContext.json b/docs/symbols/Roo.form.HtmlEditor.ToolbarContext.json index 1f9a33cd1f..56e37c1580 100644 --- a/docs/symbols/Roo.form.HtmlEditor.ToolbarContext.json +++ b/docs/symbols/Roo.form.HtmlEditor.ToolbarContext.json @@ -12,34 +12,39 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "disable", "type" : "Object", "desc" : "List of toolbar elements to disable", - "memberOf" : "Roo.form.HtmlEditor.ToolbarContext", - "optvals" : [] + "memberOf" : "" }, { "name" : "styles", "type" : "Object", "desc" : "List of styles \n eg. { '*' : [ 'headline' ] , 'TD' : [ 'underline', 'double-underline' ] } \n\nThese must be defined in the page, so they get rendered correctly..\n.headline { }\nTD.underline { }", - "memberOf" : "Roo.form.HtmlEditor.ToolbarContext", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "updateToolbar", + "type" : "function", "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.\n\nNote you can force an update by calling on('editorevent', scope, false)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.HtmlEditor.ToolbarContext", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] } diff --git a/docs/symbols/Roo.form.HtmlEditor.ToolbarStandard.json b/docs/symbols/Roo.form.HtmlEditor.ToolbarStandard.json index 0e6d5052fb..00d4c6819f 100644 --- a/docs/symbols/Roo.form.HtmlEditor.ToolbarStandard.json +++ b/docs/symbols/Roo.form.HtmlEditor.ToolbarStandard.json @@ -12,62 +12,63 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "createLinkText", "type" : "String", "desc" : "The default text for the create link prompt", - "memberOf" : "Roo.form.HtmlEditor.ToolbarStandard", - "optvals" : [] + "memberOf" : "" }, { "name" : "btns", "type" : "Array", "desc" : "List of additional buttons.\n\n\nNEEDS Extra CSS? \n.x-html-editor-tb .x-edit-none .x-btn-text { background: none; }", - "memberOf" : "Roo.form.HtmlEditor.ToolbarStandard", - "optvals" : [] + "memberOf" : "" }, { "name" : "defaultFont", "type" : "String", "desc" : "default font to use.", - "memberOf" : "Roo.form.HtmlEditor.ToolbarStandard", - "optvals" : [] + "memberOf" : "" }, { "name" : "defaultLinkValue", "type" : "String", "desc" : "The default value for the create link prompt (defaults to http:/ /)", - "memberOf" : "Roo.form.HtmlEditor.ToolbarStandard", - "optvals" : [] + "memberOf" : "" }, { "name" : "fontFamilies", "type" : "Array", "desc" : "An array of available font families", - "memberOf" : "Roo.form.HtmlEditor.ToolbarStandard", - "optvals" : [] + "memberOf" : "" }, { "name" : "disable", "type" : "Object", "desc" : "List of elements to disable..", - "memberOf" : "Roo.form.HtmlEditor.ToolbarStandard", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "updateToolbar", + "type" : "function", "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.HtmlEditor.ToolbarStandard", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] } diff --git a/docs/symbols/Roo.form.HtmlEditor.json b/docs/symbols/Roo.form.HtmlEditor.json index ce64d429aa..b7121c96a3 100644 --- a/docs/symbols/Roo.form.HtmlEditor.json +++ b/docs/symbols/Roo.form.HtmlEditor.json @@ -17,198 +17,177 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "whitelist", "type" : "Array", "desc" : "of html tags - in addition to statndard whitelist", - "memberOf" : "Roo.form.HtmlEditor", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to disable the field (defaults to false).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "name", "type" : "String", "desc" : "The field's HTML name attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "resizable", "type" : "String", "desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.", - "memberOf" : "Roo.form.HtmlEditor", - "optvals" : [] + "memberOf" : "" }, { "name" : "toolbars", "type" : "Array", "desc" : "Array of toolbars. - defaults to just the Standard one", - "memberOf" : "Roo.form.HtmlEditor", - "optvals" : [] + "memberOf" : "" }, { "name" : "width", "type" : "Number", "desc" : "(in pixels)", - "memberOf" : "Roo.form.HtmlEditor", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowComments", "type" : "boolean", "desc" : "- default false - allow comments in HTML source - by default they are stripped - if you are editing email you may need this.", - "memberOf" : "Roo.form.HtmlEditor", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "height", "type" : "Number", "desc" : "(in pixels)", - "memberOf" : "Roo.form.HtmlEditor", - "optvals" : [] + "memberOf" : "" }, { "name" : "clearUp", "type" : "Boolean", "desc" : "", - "memberOf" : "Roo.form.HtmlEditor", - "optvals" : [] + "memberOf" : "" }, { "name" : "value", "type" : "Mixed", "desc" : "A value to initialize this field with.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "msgTarget", "type" : "String", "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the field's underlying element.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldLabel", "type" : "String", "desc" : "Label to use when rendering a form.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "stylesheets", "type" : "Array", "desc" : "url of stylesheets. set to [] to disable stylesheets.", - "memberOf" : "Roo.form.HtmlEditor", - "optvals" : [] + "memberOf" : "" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "blacklist", "type" : "Array", "desc" : "of html tags - in addition to standard blacklist.", - "memberOf" : "Roo.form.HtmlEditor", - "optvals" : [] + "memberOf" : "" }, { "name" : "qtip", "type" : "String", "desc" : "Mouse over tip", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" } ], "methods" : [ { "name" : "createToolbar", + "type" : "function", "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.", + "sig" : "(editor)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.HtmlEditor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "editor", @@ -221,29 +200,39 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.HtmlEditor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "toggleSourceEdit", + "type" : "function", "desc" : "Toggles the editor between standard and source edit mode.", + "sig" : "(sourceEdit)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.HtmlEditor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sourceEdit", @@ -256,29 +245,39 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.HtmlEditor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -290,15 +289,20 @@ }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -310,15 +314,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -331,15 +340,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -351,15 +365,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -371,15 +390,20 @@ }, { "name" : "applyTo", + "type" : "function", "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -398,43 +422,58 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isDirty", + "type" : "function", "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -447,15 +486,20 @@ }, { "name" : "isValid", + "type" : "function", "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "preventMark", @@ -474,43 +518,58 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "hasChanged", + "type" : "function", "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -523,15 +582,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -550,29 +614,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -597,15 +671,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -624,15 +703,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -663,15 +747,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -684,15 +773,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -704,15 +798,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -731,15 +830,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -758,15 +862,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -778,15 +887,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -799,43 +913,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -848,15 +977,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -868,15 +1002,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -895,15 +1034,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -915,15 +1059,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -935,15 +1084,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -962,15 +1116,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -982,15 +1141,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1002,29 +1166,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1055,15 +1229,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1088,15 +1267,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1109,15 +1293,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1130,15 +1319,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1163,15 +1357,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1196,15 +1395,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1223,15 +1427,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1256,15 +1465,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1297,8 +1511,10 @@ "events" : [ { "name" : "blur", + "type" : "function", "desc" : "", - "memberOf" : "Roo.form.HtmlEditor", + "sig" : "function ()\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1308,8 +1524,10 @@ }, { "name" : "editmodechange", + "type" : "function", "desc" : "Fires when the editor switches edit modes", - "memberOf" : "Roo.form.HtmlEditor", + "sig" : "function (_self, sourceEdit)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1332,8 +1550,10 @@ }, { "name" : "firstfocus", + "type" : "function", "desc" : "Fires when on first focus - needed by toolbars..", - "memberOf" : "Roo.form.HtmlEditor", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1350,8 +1570,10 @@ }, { "name" : "initialize", + "type" : "function", "desc" : "Fires when the editor is fully initialized (including the iframe)", - "memberOf" : "Roo.form.HtmlEditor", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1368,8 +1590,10 @@ }, { "name" : "change", + "type" : "function", "desc" : "", - "memberOf" : "Roo.form.HtmlEditor", + "sig" : "function ()\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1379,8 +1603,10 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "", - "memberOf" : "Roo.form.HtmlEditor", + "sig" : "function ()\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1390,8 +1616,10 @@ }, { "name" : "autosave", + "type" : "function", "desc" : "Auto save the htmlEditor value as a file into Events", - "memberOf" : "Roo.form.HtmlEditor", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1408,8 +1636,10 @@ }, { "name" : "focus", + "type" : "function", "desc" : "", - "memberOf" : "Roo.form.HtmlEditor", + "sig" : "function ()\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1419,8 +1649,10 @@ }, { "name" : "push", + "type" : "function", "desc" : "Fires when the iframe editor is updated with content from the textarea.", - "memberOf" : "Roo.form.HtmlEditor", + "sig" : "function (_self, html)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1443,8 +1675,10 @@ }, { "name" : "activate", + "type" : "function", "desc" : "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event.", - "memberOf" : "Roo.form.HtmlEditor", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1461,8 +1695,10 @@ }, { "name" : "editorevent", + "type" : "function", "desc" : "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.", - "memberOf" : "Roo.form.HtmlEditor", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1479,8 +1715,10 @@ }, { "name" : "beforepush", + "type" : "function", "desc" : "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push.", - "memberOf" : "Roo.form.HtmlEditor", + "sig" : "function (_self, html)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1503,8 +1741,10 @@ }, { "name" : "sync", + "type" : "function", "desc" : "Fires when the textarea is updated with content from the editor iframe.", - "memberOf" : "Roo.form.HtmlEditor", + "sig" : "function (_self, html)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1527,8 +1767,10 @@ }, { "name" : "savedpreview", + "type" : "function", "desc" : "preview the saved version of htmlEditor", - "memberOf" : "Roo.form.HtmlEditor", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1545,8 +1787,10 @@ }, { "name" : "stylesheetsclick", + "type" : "function", "desc" : "Fires when press the Sytlesheets button", - "memberOf" : "Roo.form.HtmlEditor", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1563,8 +1807,10 @@ }, { "name" : "beforesync", + "type" : "function", "desc" : "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync.", - "memberOf" : "Roo.form.HtmlEditor", + "sig" : "function (_self, html)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1587,7 +1833,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1605,7 +1853,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1629,7 +1879,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1653,7 +1905,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1683,7 +1937,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1725,7 +1981,9 @@ }, { "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" : "", @@ -1743,7 +2001,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1761,7 +2021,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1779,7 +2041,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1797,7 +2061,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1815,7 +2081,9 @@ }, { "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" : "", @@ -1833,7 +2101,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1851,7 +2121,9 @@ }, { "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" : "", @@ -1869,7 +2141,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1887,7 +2161,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.Layout.json b/docs/symbols/Roo.form.Layout.json index b3b1979313..308be9d36e 100644 --- a/docs/symbols/Roo.form.Layout.json +++ b/docs/symbols/Roo.form.Layout.json @@ -22,107 +22,99 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "labelAlign", "type" : "String", "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "hideLabels", "type" : "Boolean", "desc" : "True to suppress the display of field labels in this layout (defaults to false)", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String/Object/Function", "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "labelWidth", "type" : "Number", "desc" : "Fixed width in pixels of all field labels (defaults to undefined)", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "" }, { "name" : "labelSeparator", "type" : "String", "desc" : "The separator to use after field labels (defaults to ':')", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "" }, { "name" : "autoCreate", "type" : "String/Object", "desc" : "A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'})", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "" }, { "name" : "clear", "type" : "Boolean", "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "addxtype", + "type" : "function", "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column", + "sig" : "(config)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Layout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -135,15 +127,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -155,15 +152,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -176,43 +178,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -225,15 +242,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -245,15 +267,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -272,15 +299,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -292,15 +324,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -312,15 +349,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -339,15 +381,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -359,15 +406,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -379,29 +431,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -432,15 +494,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -465,15 +532,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -486,15 +558,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -507,15 +584,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -540,15 +622,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -573,15 +660,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -600,15 +692,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -633,15 +730,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -674,7 +776,9 @@ "events" : [ { "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" : "", @@ -692,7 +796,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -710,7 +816,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -728,7 +836,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -746,7 +856,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -764,7 +876,9 @@ }, { "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" : "", @@ -782,7 +896,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -800,7 +916,9 @@ }, { "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" : "", @@ -818,7 +936,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -836,7 +956,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.MonthField.json b/docs/symbols/Roo.form.MonthField.json index 0dbeef996d..9e227d3987 100644 --- a/docs/symbols/Roo.form.MonthField.json +++ b/docs/symbols/Roo.form.MonthField.json @@ -26,401 +26,351 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "triggerClass", "type" : "String", "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be appended if specified (defaults to 'x-form-date-trigger'\nwhich displays a calendar icon).", - "memberOf" : "Roo.form.MonthField", - "optvals" : [] + "memberOf" : "" }, { "name" : "useIso", "type" : "Boolean", "desc" : "if enabled, then the date field will use a hidden field to store the \nreal value as iso formated date. default (true)", - "memberOf" : "Roo.form.MonthField", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to disable the field (defaults to false).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "disabledDates", "type" : "Array", "desc" : "An array of \"dates\" to disable, as strings. These strings will be used to build a dynamic regular\nexpression so they are very powerful. Some examples:\n
    \n
  • [\"03/08/2003\", \"09/16/2003\"] would disable those exact dates
  • \n
  • [\"03/08\", \"09/16\"] would disable those days for every year
  • \n
  • [\"^03/08\"] would only match the beginning (useful if you are using short years)
  • \n
  • [\"03/../2006\"] would disable every day in March 2006
  • \n
  • [\"^03\"] would disable every day in every March
  • \n
\nIn order to support regular expressions, if you are using a date format that has \".\" in it, you will have to\nescape the dot when restricting dates. For example: [\"03\\\\.08\\\\.03\"].", - "memberOf" : "Roo.form.MonthField", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "String", "desc" : "The field's HTML name attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "width", "type" : "Number", "desc" : "width (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "regexText", "type" : "String", "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "maxValue", "type" : "Date/String", "desc" : "The maximum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).", - "memberOf" : "Roo.form.MonthField", - "optvals" : [] + "memberOf" : "" }, { "name" : "altFormats", "type" : "String", "desc" : "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').", - "memberOf" : "Roo.form.MonthField", - "optvals" : [] + "memberOf" : "" }, { "name" : "minValue", "type" : "Date/String", "desc" : "The minimum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).", - "memberOf" : "Roo.form.MonthField", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "disabledDaysText", "type" : "String", "desc" : "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')", - "memberOf" : "Roo.form.MonthField", - "optvals" : [] + "memberOf" : "" }, { "name" : "minText", "type" : "String", "desc" : "The error text to display when the date in the cell is before minValue (defaults to\n'The date in this field must be after {minValue}').", - "memberOf" : "Roo.form.MonthField", - "optvals" : [] + "memberOf" : "" }, { "name" : "height", "type" : "Number", "desc" : "height (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "emptyText", "type" : "String", "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "value", "type" : "Mixed", "desc" : "A value to initialize this field with.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "msgFx", "type" : "String", "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "disabledDatesText", "type" : "String", "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')", - "memberOf" : "Roo.form.MonthField", - "optvals" : [] + "memberOf" : "" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "msgTarget", "type" : "String", "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "disabledDays", "type" : "Array", "desc" : "An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).", - "memberOf" : "Roo.form.MonthField", - "optvals" : [] + "memberOf" : "" }, { "name" : "hideTrigger", "type" : "Boolean", "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", - "memberOf" : "Roo.form.TriggerField", - "optvals" : [] + "memberOf" : "Roo.form.TriggerField" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the field's underlying element.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "inputType", "type" : "String", "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldClass", "type" : "String", "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "allowLeadingSpace", "type" : "Boolean", "desc" : "True to prevent the stripping of leading white space", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "autoCreate", "type" : "String/Object", "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"10\", autocomplete: \"off\"})", - "memberOf" : "Roo.form.MonthField", - "optvals" : [] + "memberOf" : "" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "invalidClass", "type" : "String", "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldLabel", "type" : "String", "desc" : "Label to use when rendering a form.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "format", "type" : "String", "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').", - "memberOf" : "Roo.form.MonthField", - "optvals" : [] + "memberOf" : "" }, { "name" : "maxTextf", "type" : "String", "desc" : "The error text to display when the date in the cell is after maxValue (defaults to\n'The date in this field must be before {maxValue}').", - "memberOf" : "Roo.form.MonthField", - "optvals" : [] + "memberOf" : "" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "qtip", "type" : "String", "desc" : "Mouse over tip", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to display when the date in the field is invalid (defaults to\n'{value} is not a valid date - it must be in the format {format}').", - "memberOf" : "Roo.form.MonthField", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "getValue", + "type" : "function", "desc" : "Returns the current date value of the date field.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.MonthField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -432,15 +382,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using MonthField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n
Usage:\n
\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\nmonthField.setValue(dt);\n\n//Pass a date string (default format):\nmonthField.setValue('5/4/06');\n\n//Pass a date string (custom format):\nmonthField.format = 'Y-m-d';\nmonthField.setValue('2006-5-4');\n
", + "sig" : "(date)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.MonthField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "date", @@ -453,15 +408,20 @@ }, { "name" : "onTriggerClick", + "type" : "function", "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.form.TriggerField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TriggerField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -474,29 +434,39 @@ }, { "name" : "autoSize", + "type" : "function", "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TriggerField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TriggerField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "selectText", + "type" : "function", "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "start", @@ -515,15 +485,20 @@ }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -542,29 +517,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -576,15 +561,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -596,15 +586,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -617,15 +612,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -637,15 +637,20 @@ }, { "name" : "applyTo", + "type" : "function", "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -664,43 +669,58 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isDirty", + "type" : "function", "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -713,29 +733,39 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isValid", + "type" : "function", "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "preventMark", @@ -754,29 +784,39 @@ }, { "name" : "hasChanged", + "type" : "function", "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -789,15 +829,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -816,29 +861,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -863,15 +918,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -890,15 +950,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -929,15 +994,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -950,15 +1020,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -970,15 +1045,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -997,15 +1077,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -1024,15 +1109,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1044,15 +1134,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -1065,43 +1160,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -1114,15 +1224,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1134,15 +1249,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -1161,15 +1281,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1181,15 +1306,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1201,15 +1331,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1228,15 +1363,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1248,15 +1388,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1268,29 +1413,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1321,15 +1476,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1354,15 +1514,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1375,15 +1540,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1396,15 +1566,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1429,15 +1604,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1462,15 +1642,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1489,15 +1674,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1522,15 +1712,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1563,8 +1758,10 @@ "events" : [ { "name" : "select", + "type" : "function", "desc" : "Fires when a date is selected", - "memberOf" : "Roo.form.MonthField", + "sig" : "function (combo, date)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1587,7 +1784,9 @@ }, { "name" : "autosize", + "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", @@ -1611,7 +1810,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1629,7 +1830,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1647,7 +1850,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1671,7 +1876,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1689,7 +1896,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1713,7 +1922,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1737,7 +1948,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1767,7 +1980,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1797,7 +2012,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1839,7 +2056,9 @@ }, { "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" : "", @@ -1857,7 +2076,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1875,7 +2096,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1893,7 +2116,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1911,7 +2136,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1929,7 +2156,9 @@ }, { "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" : "", @@ -1947,7 +2176,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1965,7 +2196,9 @@ }, { "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" : "", @@ -1983,7 +2216,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2001,7 +2236,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.NumberField.json b/docs/symbols/Roo.form.NumberField.json index 7399ca3050..7bc26c0feb 100644 --- a/docs/symbols/Roo.form.NumberField.json +++ b/docs/symbols/Roo.form.NumberField.json @@ -25,394 +25,345 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to disable the field (defaults to false).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "name", "type" : "String", "desc" : "The field's HTML name attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "width", "type" : "Number", "desc" : "width (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "nanText", "type" : "String", "desc" : "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")", - "memberOf" : "Roo.form.NumberField", - "optvals" : [] + "memberOf" : "" }, { "name" : "regexText", "type" : "String", "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "maxValue", "type" : "Number", "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.form.NumberField", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "minValue", "type" : "Number", "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)", - "memberOf" : "Roo.form.NumberField", - "optvals" : [] + "memberOf" : "" }, { "name" : "height", "type" : "Number", "desc" : "height (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "decimalPrecision", "type" : "Number", "desc" : "The maximum precision to display after the decimal separator (defaults to 2)", - "memberOf" : "Roo.form.NumberField", - "optvals" : [] + "memberOf" : "" }, { "name" : "minText", "type" : "String", "desc" : "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")", - "memberOf" : "Roo.form.NumberField", - "optvals" : [] + "memberOf" : "" }, { "name" : "emptyText", "type" : "String", "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "value", "type" : "Mixed", "desc" : "A value to initialize this field with.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "msgFx", "type" : "String", "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "msgTarget", "type" : "String", "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "allowDecimals", "type" : "Boolean", "desc" : "False to disallow decimal values (defaults to true)", - "memberOf" : "Roo.form.NumberField", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowNegative", "type" : "Boolean", "desc" : "False to prevent entering a negative sign (defaults to true)", - "memberOf" : "Roo.form.NumberField", - "optvals" : [] + "memberOf" : "" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the field's underlying element.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldClass", "type" : "String", "desc" : "The default CSS class for the field (defaults to \"x-form-field x-form-num-field\")", - "memberOf" : "Roo.form.NumberField", - "optvals" : [] + "memberOf" : "" }, { "name" : "inputType", "type" : "String", "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "allowLeadingSpace", "type" : "Boolean", "desc" : "True to prevent the stripping of leading white space", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "autoCreate", "type" : "String/Object", "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "invalidClass", "type" : "String", "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "growMin", "type" : "Number", "desc" : "The minimum width to allow when grow = true (defaults to 30)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldLabel", "type" : "String", "desc" : "Label to use when rendering a form.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "decimalSeparator", "type" : "String", "desc" : "Character(s) to allow as the decimal separator (defaults to '.')", - "memberOf" : "Roo.form.NumberField", - "optvals" : [] + "memberOf" : "" }, { "name" : "growMax", "type" : "Number", "desc" : "The maximum width to allow when grow = true (defaults to 800)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "grow", "type" : "Boolean", "desc" : "True if this field should automatically grow and shrink to its content", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "maxText", "type" : "String", "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")", - "memberOf" : "Roo.form.NumberField", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "qtip", "type" : "String", "desc" : "Mouse over tip", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" } ], "methods" : [ { "name" : "selectText", + "type" : "function", "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "start", @@ -431,15 +382,20 @@ }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -458,43 +414,58 @@ }, { "name" : "autoSize", + "type" : "function", "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -506,15 +477,20 @@ }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -526,15 +502,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -547,15 +528,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -567,15 +553,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -588,15 +579,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -608,15 +604,20 @@ }, { "name" : "applyTo", + "type" : "function", "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -635,43 +636,58 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isDirty", + "type" : "function", "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -684,29 +700,39 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isValid", + "type" : "function", "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "preventMark", @@ -725,29 +751,39 @@ }, { "name" : "hasChanged", + "type" : "function", "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -760,15 +796,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -787,29 +828,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -834,15 +885,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -861,15 +917,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -900,15 +961,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -921,15 +987,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -941,15 +1012,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -968,15 +1044,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -995,15 +1076,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1015,15 +1101,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -1036,43 +1127,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -1085,15 +1191,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1105,15 +1216,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -1132,15 +1248,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1152,15 +1273,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1172,15 +1298,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1199,15 +1330,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1219,15 +1355,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1239,29 +1380,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1292,15 +1443,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1325,15 +1481,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1346,15 +1507,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1367,15 +1533,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1400,15 +1571,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1433,15 +1609,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1460,15 +1641,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1493,15 +1679,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1534,7 +1725,9 @@ "events" : [ { "name" : "autosize", + "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", @@ -1558,7 +1751,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1576,7 +1771,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1594,7 +1791,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1618,7 +1817,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1636,7 +1837,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1660,7 +1863,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1684,7 +1889,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1714,7 +1921,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1744,7 +1953,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1786,7 +1997,9 @@ }, { "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" : "", @@ -1804,7 +2017,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1822,7 +2037,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1840,7 +2057,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1858,7 +2077,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1876,7 +2097,9 @@ }, { "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" : "", @@ -1894,7 +2117,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1912,7 +2137,9 @@ }, { "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" : "", @@ -1930,7 +2157,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1948,7 +2177,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.Radio.json b/docs/symbols/Roo.form.Radio.json index 71c1a1db75..caa6219f0d 100644 --- a/docs/symbols/Roo.form.Radio.json +++ b/docs/symbols/Roo.form.Radio.json @@ -25,233 +25,207 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "inputType", "type" : "String", "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "msgFx", "type" : "String", "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "inputValue", "type" : "String", "desc" : "The value that should go into the generated input element's value attribute", - "memberOf" : "Roo.form.Checkbox", - "optvals" : [] + "memberOf" : "Roo.form.Checkbox" }, { "name" : "fieldLabel", "type" : "String", "desc" : "Label to use when rendering a form.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "msgTarget", "type" : "String", "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to disable the field (defaults to false).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "value", "type" : "Mixed", "desc" : "A value to initialize this field with.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "invalidClass", "type" : "String", "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the field's underlying element.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "autoCreate", "type" : "String/Object", "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})", - "memberOf" : "Roo.form.Checkbox", - "optvals" : [] + "memberOf" : "Roo.form.Checkbox" }, { "name" : "valueOff", "type" : "String", "desc" : "The value that should go into the generated input element's value when unchecked.", - "memberOf" : "Roo.form.Checkbox", - "optvals" : [] + "memberOf" : "Roo.form.Checkbox" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "boxLabel", "type" : "String", "desc" : "The text that appears beside the checkbox", - "memberOf" : "Roo.form.Checkbox", - "optvals" : [] + "memberOf" : "Roo.form.Checkbox" }, { "name" : "width", "type" : "Number", "desc" : "width (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldClass", "type" : "String", "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")", - "memberOf" : "Roo.form.Checkbox", - "optvals" : [] + "memberOf" : "Roo.form.Checkbox" }, { "name" : "checked", "type" : "Boolean", "desc" : "True if the the checkbox should render already checked (defaults to false)", - "memberOf" : "Roo.form.Checkbox", - "optvals" : [] + "memberOf" : "Roo.form.Checkbox" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)", - "memberOf" : "Roo.form.Checkbox", - "optvals" : [] + "memberOf" : "Roo.form.Checkbox" }, { "name" : "name", "type" : "String", "desc" : "The field's HTML name attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "qtip", "type" : "String", "desc" : "Mouse over tip", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "height", "type" : "Number", "desc" : "height (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "getGroupValue", + "type" : "function", "desc" : "If this radio is part of a group, it will return the selected value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Radio", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -263,15 +237,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.", + "sig" : "(value, suppressEvent)", + "static" : false, + "memberOf" : "Roo.form.Checkbox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Checkbox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -290,15 +269,20 @@ }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the checked state of the checkbox.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Checkbox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Checkbox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -310,15 +294,20 @@ }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -330,15 +319,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -350,15 +344,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -371,15 +370,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -391,15 +395,20 @@ }, { "name" : "applyTo", + "type" : "function", "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -418,43 +427,58 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isDirty", + "type" : "function", "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -467,29 +491,39 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isValid", + "type" : "function", "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "preventMark", @@ -508,43 +542,58 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "hasChanged", + "type" : "function", "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -557,15 +606,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -584,29 +638,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -631,15 +695,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -658,15 +727,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -697,15 +771,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -718,15 +797,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -738,15 +822,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -765,15 +854,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -792,15 +886,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -812,15 +911,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -833,43 +937,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -882,15 +1001,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -902,15 +1026,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -929,15 +1058,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -949,15 +1083,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -969,15 +1108,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -996,15 +1140,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1016,15 +1165,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1036,29 +1190,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1089,15 +1253,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1122,15 +1291,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1143,15 +1317,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1164,15 +1343,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1197,15 +1381,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1230,15 +1419,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1257,15 +1451,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1290,15 +1489,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1331,7 +1535,9 @@ "events" : [ { "name" : "check", + "type" : "function", "desc" : "Fires when the checkbox is checked or unchecked.", + "sig" : "function (_self, checked)\n{\n\n}", "memberOf" : "Roo.form.Checkbox", "example" : "", "deprecated" : "", @@ -1355,7 +1561,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1373,7 +1581,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1391,7 +1601,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1415,7 +1627,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1433,7 +1647,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1457,7 +1673,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1481,7 +1699,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1511,7 +1731,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1541,7 +1763,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1583,7 +1807,9 @@ }, { "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" : "", @@ -1601,7 +1827,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1619,7 +1847,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1637,7 +1867,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1655,7 +1887,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1673,7 +1907,9 @@ }, { "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" : "", @@ -1691,7 +1927,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1709,7 +1947,9 @@ }, { "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" : "", @@ -1727,7 +1967,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1745,7 +1987,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.Row.json b/docs/symbols/Roo.form.Row.json index 713f59d671..1bc2eeb245 100644 --- a/docs/symbols/Roo.form.Row.json +++ b/docs/symbols/Roo.form.Row.json @@ -23,121 +23,111 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "labelAlign", "type" : "String", "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "Roo.form.Layout" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "hideLabels", "type" : "Boolean", "desc" : "True to suppress the display of field labels in this layout (defaults to false)", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "Roo.form.Layout" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "style", "type" : "String/Object/Function", "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "Roo.form.Layout" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "labelWidth", "type" : "Number", "desc" : "Fixed width in pixels of all field labels (defaults to undefined)", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "Roo.form.Layout" }, { "name" : "labelSeparator", "type" : "String", "desc" : "The separator to use after field labels (defaults to ':')", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "Roo.form.Layout" }, { "name" : "autoCreate", "type" : "String/Object", "desc" : "A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'})", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "Roo.form.Layout" }, { "name" : "clear", "type" : "Boolean", "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)", - "memberOf" : "Roo.form.Layout", - "optvals" : [] + "memberOf" : "Roo.form.Layout" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "width", "type" : "Number/String", "desc" : "The fixed width of the column in pixels or CSS value (defaults to \"auto\")", - "memberOf" : "Roo.form.Row", - "optvals" : [] + "memberOf" : "" }, { "name" : "height", "type" : "Number/String", "desc" : "The fixed height of the column in pixels or CSS value (defaults to \"auto\")", - "memberOf" : "Roo.form.Row", - "optvals" : [] + "memberOf" : "" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "addxtype", + "type" : "function", "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column", + "sig" : "(config)", + "static" : false, + "memberOf" : "Roo.form.Layout", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Layout", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -150,15 +140,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -170,15 +165,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -191,43 +191,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -240,15 +255,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -260,15 +280,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -287,15 +312,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -307,15 +337,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -327,15 +362,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -354,15 +394,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -374,15 +419,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -394,29 +444,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -447,15 +507,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -480,15 +545,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -501,15 +571,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -522,15 +597,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -555,15 +635,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -588,15 +673,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -615,15 +705,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -648,15 +743,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -689,7 +789,9 @@ "events" : [ { "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" : "", @@ -707,7 +809,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -725,7 +829,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -743,7 +849,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -761,7 +869,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -779,7 +889,9 @@ }, { "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" : "", @@ -797,7 +909,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -815,7 +929,9 @@ }, { "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" : "", @@ -833,7 +949,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -851,7 +969,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.Select.json b/docs/symbols/Roo.form.Select.json index 8f2dc77228..68e3c8b80d 100644 --- a/docs/symbols/Roo.form.Select.json +++ b/docs/symbols/Roo.form.Select.json @@ -26,583 +26,507 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "triggerClass", "type" : "String", "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be appended if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "pageSize", "type" : "Number", "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "title", "type" : "String", "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "queryParam", "type" : "String", "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to disable the field (defaults to false).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "resizable", "type" : "Boolean", "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "name", "type" : "String", "desc" : "The field's HTML name attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "editable", "type" : "Boolean", "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "width", "type" : "Number", "desc" : "width (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "regexText", "type" : "String", "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "listWidth", "type" : "Number", "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "tpl", "type" : "String/Roo.Template", "desc" : "The template to use to render the output", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "typeAheadDelay", "type" : "Number", "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "height", "type" : "Number", "desc" : "height (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "disableClear", "type" : "Boolean", "desc" : "Disable showing of clear button.", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "store", "type" : "Roo.data.Store", "desc" : "The data store to which this combo is bound (defaults to undefined)", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "value", "type" : "Mixed", "desc" : "A value to initialize this field with.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "emptyText", "type" : "String", "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "defaultValue", "type" : "String", "desc" : "The value displayed after loading the store.", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "msgFx", "type" : "String", "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "allQuery", "type" : "String", "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "minListWidth", "type" : "Number", "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "alwaysQuery", "type" : "Boolean", "desc" : "Disable caching of results, and always send query", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "msgTarget", "type" : "String", "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "shadow", "type" : "Boolean/String", "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "valueNotFoundText", "type" : "String", "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "displayField", "type" : "String", "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "hiddenName", "type" : "String", "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "selectedClass", "type" : "String", "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "hideTrigger", "type" : "Boolean", "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", - "memberOf" : "Roo.form.TriggerField", - "optvals" : [] + "memberOf" : "Roo.form.TriggerField" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the field's underlying element.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "listAlign", "type" : "String", "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "forceSelection", "type" : "Boolean", "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "typeAhead", "type" : "Boolean", "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "triggerAction", "type" : "String", "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "inputType", "type" : "String", "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldClass", "type" : "String", "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "autoCreate", "type" : "Boolean/Object", "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "minChars", "type" : "Number", "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "growMin", "type" : "Number", "desc" : "", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowLeadingSpace", "type" : "Boolean", "desc" : "True to prevent the stripping of leading white space", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "invalidClass", "type" : "String", "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "blockFocus", "type" : "Boolean", "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "fieldLabel", "type" : "String", "desc" : "Label to use when rendering a form.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "growMax", "type" : "Number", "desc" : "", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "transform", "type" : "String/HTMLElement/Element", "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "listClass", "type" : "String", "desc" : "CSS class to apply to the dropdown list element (defaults to '')", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "handleHeight", "type" : "Number", "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "grow", "type" : "Boolean", "desc" : "", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "queryDelay", "type" : "Number", "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "mode", "type" : "String", "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "qtip", "type" : "String", "desc" : "Mouse over tip", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maxHeight", "type" : "Number", "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "valueField", "type" : "String", "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "loadingText", "type" : "String", "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "lazyRender", "type" : "Boolean", "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)", - "memberOf" : "Roo.form.Select", - "optvals" : [] + "memberOf" : "" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" } ], "methods" : [ { "name" : "select", + "type" : "function", "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "sig" : "(index, scrollIntoView)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Select", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -621,43 +545,58 @@ }, { "name" : "collapse", + "type" : "function", "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Select", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "clearValue", + "type" : "function", "desc" : "Clears any text/value currently set in the field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Select", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "selectByValue", + "type" : "function", "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.", + "sig" : "(value, scrollIntoView)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Select", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -682,29 +621,39 @@ }, { "name" : "isExpanded", + "type" : "function", "desc" : "Returns true if the dropdown list is expanded, else false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Select", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the currently selected field value or empty string if no value is set.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Select", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -716,15 +665,20 @@ }, { "name" : "setFromData", + "type" : "function", "desc" : "Sets the value of the field based on a object which is related to the record format for the store.", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Select", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -737,15 +691,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Select", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -758,29 +717,39 @@ }, { "name" : "setWidth", + "type" : "function", "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Select", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setEditable", + "type" : "function", "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Select", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -793,15 +762,20 @@ }, { "name" : "doQuery", + "type" : "function", "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.", + "sig" : "(query, forceAll)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Select", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "query", @@ -820,29 +794,39 @@ }, { "name" : "expand", + "type" : "function", "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Select", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onTriggerClick", + "type" : "function", "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.form.TriggerField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TriggerField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -855,29 +839,39 @@ }, { "name" : "autoSize", + "type" : "function", "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TriggerField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TriggerField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "selectText", + "type" : "function", "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "start", @@ -896,15 +890,20 @@ }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -923,29 +922,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -957,15 +966,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -977,15 +991,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -998,15 +1017,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1018,15 +1042,20 @@ }, { "name" : "applyTo", + "type" : "function", "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -1045,43 +1074,58 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isDirty", + "type" : "function", "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -1094,29 +1138,39 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isValid", + "type" : "function", "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "preventMark", @@ -1135,29 +1189,39 @@ }, { "name" : "hasChanged", + "type" : "function", "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -1170,15 +1234,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -1197,29 +1266,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -1244,15 +1323,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -1271,15 +1355,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -1310,15 +1399,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -1331,15 +1425,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1351,15 +1450,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -1378,15 +1482,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -1405,15 +1514,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1425,15 +1539,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -1446,43 +1565,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -1495,15 +1629,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1515,15 +1654,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -1542,15 +1686,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1562,15 +1711,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1582,15 +1736,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1609,15 +1768,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1629,15 +1793,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1649,29 +1818,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1702,15 +1881,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1735,15 +1919,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1756,15 +1945,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1777,15 +1971,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1810,15 +2009,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1843,15 +2047,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1870,15 +2079,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1903,15 +2117,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1944,7 +2163,9 @@ "events" : [ { "name" : "autosize", + "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", @@ -1968,7 +2189,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1986,7 +2209,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2004,7 +2229,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2028,7 +2255,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2046,7 +2275,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2070,7 +2301,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2094,7 +2327,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -2124,7 +2359,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -2154,7 +2391,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -2196,7 +2435,9 @@ }, { "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" : "", @@ -2214,7 +2455,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2232,7 +2475,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2250,7 +2495,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2268,7 +2515,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2286,7 +2535,9 @@ }, { "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" : "", @@ -2304,7 +2555,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2322,7 +2575,9 @@ }, { "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" : "", @@ -2340,7 +2595,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -2358,7 +2615,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.Signature.json b/docs/symbols/Roo.form.Signature.json index 24fc771edf..46e2abda94 100644 --- a/docs/symbols/Roo.form.Signature.json +++ b/docs/symbols/Roo.form.Signature.json @@ -24,219 +24,195 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "inputType", "type" : "String", "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "msgFx", "type" : "String", "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldLabel", "type" : "String", "desc" : "Label to use when rendering a form.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "msgTarget", "type" : "String", "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to disable the field (defaults to false).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "value", "type" : "Mixed", "desc" : "A value to initialize this field with.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to false)", - "memberOf" : "Roo.form.Signature", - "optvals" : [] + "memberOf" : "" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "invalidClass", "type" : "String", "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the field's underlying element.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "autoCreate", "type" : "String/Object", "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "width", "type" : "Number", "desc" : "The signature panel width (defaults to 300)", - "memberOf" : "Roo.form.Signature", - "optvals" : [] + "memberOf" : "" }, { "name" : "labels", "type" : "Object", "desc" : "Label to use when rendering a form.\ndefaults to \nlabels : { \n clear : \"Clear\",\n confirm : \"Confirm\"\n }", - "memberOf" : "Roo.form.Signature", - "optvals" : [] + "memberOf" : "" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "height", "type" : "Number", "desc" : "The signature panel height (defaults to 100)", - "memberOf" : "Roo.form.Signature", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "String", "desc" : "The field's HTML name attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "qtip", "type" : "String", "desc" : "Mouse over tip", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldClass", "type" : "String", "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "getImageDataURI", + "type" : "function", "desc" : "when user is clicked confirm then show this image.....", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Signature", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -248,15 +224,20 @@ }, { "name" : "getConfirmed", + "type" : "function", "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Signature", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -268,15 +249,20 @@ }, { "name" : "getHeight", + "type" : "function", "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Signature", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -288,15 +274,20 @@ }, { "name" : "createToolbar", + "type" : "function", "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.", + "sig" : "(editor)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Signature", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "editor", @@ -309,15 +300,20 @@ }, { "name" : "getWidth", + "type" : "function", "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Signature", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -329,15 +325,20 @@ }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -349,15 +350,20 @@ }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -369,15 +375,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -390,15 +401,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -410,15 +426,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -431,15 +452,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -451,15 +477,20 @@ }, { "name" : "applyTo", + "type" : "function", "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -478,43 +509,58 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isDirty", + "type" : "function", "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -527,29 +573,39 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isValid", + "type" : "function", "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "preventMark", @@ -568,43 +624,58 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "hasChanged", + "type" : "function", "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -617,15 +688,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -644,29 +720,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -691,15 +777,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -718,15 +809,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -757,15 +853,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -778,15 +879,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -798,15 +904,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -825,15 +936,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -852,15 +968,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -872,15 +993,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -893,43 +1019,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -942,15 +1083,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -962,15 +1108,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -989,15 +1140,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1009,15 +1165,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1029,15 +1190,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1056,15 +1222,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1076,15 +1247,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1096,29 +1272,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1149,15 +1335,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1182,15 +1373,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1203,15 +1399,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1224,15 +1425,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1257,15 +1463,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1290,15 +1501,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1317,15 +1533,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1350,15 +1571,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1391,8 +1617,10 @@ "events" : [ { "name" : "confirm", + "type" : "function", "desc" : "Fires when the 'confirm' icon is pressed (add a listener to enable add button)", - "memberOf" : "Roo.form.Signature", + "sig" : "function (combo)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1409,8 +1637,10 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)", - "memberOf" : "Roo.form.Signature", + "sig" : "function (combo, record)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1433,7 +1663,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1451,7 +1683,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1469,7 +1703,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1493,7 +1729,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1511,7 +1749,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1535,7 +1775,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1559,7 +1801,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1589,7 +1833,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1619,7 +1865,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1661,7 +1909,9 @@ }, { "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" : "", @@ -1679,7 +1929,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1697,7 +1949,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1715,7 +1969,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1733,7 +1989,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1751,7 +2009,9 @@ }, { "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" : "", @@ -1769,7 +2029,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1787,7 +2049,9 @@ }, { "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" : "", @@ -1805,7 +2069,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1823,7 +2089,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.TextArea.json b/docs/symbols/Roo.form.TextArea.json index ef5a813d4c..1fa5b0d009 100644 --- a/docs/symbols/Roo.form.TextArea.json +++ b/docs/symbols/Roo.form.TextArea.json @@ -25,352 +25,316 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to disable the field (defaults to false).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "name", "type" : "String", "desc" : "The field's HTML name attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "width", "type" : "Number", "desc" : "width (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "regexText", "type" : "String", "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "height", "type" : "Number", "desc" : "height (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "value", "type" : "Mixed", "desc" : "A value to initialize this field with.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "emptyText", "type" : "String", "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "msgFx", "type" : "String", "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "msgTarget", "type" : "String", "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "preventScrollbars", "type" : "Boolean", "desc" : "True to prevent scrollbars from appearing regardless of how much text is\nin the field (equivalent to setting overflow: hidden, defaults to false)", - "memberOf" : "Roo.form.TextArea", - "optvals" : [] + "memberOf" : "" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the field's underlying element.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "inputType", "type" : "String", "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldClass", "type" : "String", "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "allowLeadingSpace", "type" : "Boolean", "desc" : "True to prevent the stripping of leading white space", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "autoCreate", "type" : "String/Object", "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"textarea\", style: \"width:300px;height:60px;\", autocomplete: \"off\"})", - "memberOf" : "Roo.form.TextArea", - "optvals" : [] + "memberOf" : "" }, { "name" : "invalidClass", "type" : "String", "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "growMin", "type" : "Number", "desc" : "The minimum height to allow when grow = true (defaults to 60)", - "memberOf" : "Roo.form.TextArea", - "optvals" : [] + "memberOf" : "" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldLabel", "type" : "String", "desc" : "Label to use when rendering a form.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "growMax", "type" : "Number", "desc" : "The maximum height to allow when grow = true (defaults to 1000)", - "memberOf" : "Roo.form.TextArea", - "optvals" : [] + "memberOf" : "" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "grow", "type" : "Boolean", "desc" : "True if this field should automatically grow and shrink to its content", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "qtip", "type" : "String", "desc" : "Mouse over tip", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" } ], "methods" : [ { "name" : "autoSize", + "type" : "function", "desc" : "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextArea", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "selectText", + "type" : "function", "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "start", @@ -389,15 +353,20 @@ }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -416,29 +385,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -450,15 +429,20 @@ }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -470,15 +454,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -491,15 +480,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -511,15 +505,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -532,15 +531,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -552,15 +556,20 @@ }, { "name" : "applyTo", + "type" : "function", "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -579,43 +588,58 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isDirty", + "type" : "function", "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -628,29 +652,39 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isValid", + "type" : "function", "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "preventMark", @@ -669,29 +703,39 @@ }, { "name" : "hasChanged", + "type" : "function", "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -704,15 +748,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -731,29 +780,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -778,15 +837,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -805,15 +869,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -844,15 +913,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -865,15 +939,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -885,15 +964,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -912,15 +996,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -939,15 +1028,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -959,15 +1053,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -980,43 +1079,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -1029,15 +1143,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1049,15 +1168,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -1076,15 +1200,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1096,15 +1225,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1116,15 +1250,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1143,15 +1282,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1163,15 +1307,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1183,29 +1332,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1236,15 +1395,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1269,15 +1433,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1290,15 +1459,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1311,15 +1485,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1344,15 +1523,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1377,15 +1561,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1404,15 +1593,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1437,15 +1631,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1478,7 +1677,9 @@ "events" : [ { "name" : "autosize", + "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", @@ -1502,7 +1703,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1520,7 +1723,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1538,7 +1743,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1562,7 +1769,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1580,7 +1789,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1604,7 +1815,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1628,7 +1841,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1658,7 +1873,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1688,7 +1905,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1730,7 +1949,9 @@ }, { "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" : "", @@ -1748,7 +1969,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1766,7 +1989,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1784,7 +2009,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1802,7 +2029,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1820,7 +2049,9 @@ }, { "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" : "", @@ -1838,7 +2069,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1856,7 +2089,9 @@ }, { "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" : "", @@ -1874,7 +2109,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1892,7 +2129,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.TextField.json b/docs/symbols/Roo.form.TextField.json index 5a36b52bcc..9b44cb1852 100644 --- a/docs/symbols/Roo.form.TextField.json +++ b/docs/symbols/Roo.form.TextField.json @@ -24,331 +24,291 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to disable the field (defaults to false).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "" }, { "name" : "name", "type" : "String", "desc" : "The field's HTML name attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "width", "type" : "Number", "desc" : "width (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "regexText", "type" : "String", "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "height", "type" : "Number", "desc" : "height (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "value", "type" : "Mixed", "desc" : "A value to initialize this field with.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "emptyText", "type" : "String", "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "" }, { "name" : "msgFx", "type" : "String", "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "msgTarget", "type" : "String", "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the field's underlying element.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "inputType", "type" : "String", "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldClass", "type" : "String", "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "allowLeadingSpace", "type" : "Boolean", "desc" : "True to prevent the stripping of leading white space", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "" }, { "name" : "autoCreate", "type" : "String/Object", "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "invalidClass", "type" : "String", "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "" }, { "name" : "growMin", "type" : "Number", "desc" : "The minimum width to allow when grow = true (defaults to 30)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldLabel", "type" : "String", "desc" : "Label to use when rendering a form.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "growMax", "type" : "Number", "desc" : "The maximum width to allow when grow = true (defaults to 800)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "" }, { "name" : "grow", "type" : "Boolean", "desc" : "True if this field should automatically grow and shrink to its content", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "" }, { "name" : "qtip", "type" : "String", "desc" : "Mouse over tip", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" } ], "methods" : [ { "name" : "selectText", + "type" : "function", "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "start", @@ -367,15 +327,20 @@ }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -394,43 +359,58 @@ }, { "name" : "autoSize", + "type" : "function", "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -442,15 +422,20 @@ }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -462,15 +447,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -483,15 +473,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -503,15 +498,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -524,15 +524,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -544,15 +549,20 @@ }, { "name" : "applyTo", + "type" : "function", "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -571,43 +581,58 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isDirty", + "type" : "function", "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -620,29 +645,39 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isValid", + "type" : "function", "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "preventMark", @@ -661,29 +696,39 @@ }, { "name" : "hasChanged", + "type" : "function", "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -696,15 +741,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -723,29 +773,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -770,15 +830,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -797,15 +862,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -836,15 +906,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -857,15 +932,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -877,15 +957,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -904,15 +989,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -931,15 +1021,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -951,15 +1046,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -972,43 +1072,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -1021,15 +1136,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1041,15 +1161,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -1068,15 +1193,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1088,15 +1218,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1108,15 +1243,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1135,15 +1275,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1155,15 +1300,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1175,29 +1325,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1228,15 +1388,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1261,15 +1426,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1282,15 +1452,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1303,15 +1478,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1336,15 +1516,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1369,15 +1554,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1396,15 +1586,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1429,15 +1624,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1470,8 +1670,10 @@ "events" : [ { "name" : "autosize", + "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", - "memberOf" : "Roo.form.TextField", + "sig" : "function (_self, width)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1494,7 +1696,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1512,7 +1716,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1530,7 +1736,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1554,7 +1762,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1572,7 +1782,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1596,7 +1808,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1620,7 +1834,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1650,7 +1866,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1680,7 +1898,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1722,7 +1942,9 @@ }, { "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" : "", @@ -1740,7 +1962,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1758,7 +1982,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1776,7 +2002,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1794,7 +2022,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1812,7 +2042,9 @@ }, { "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" : "", @@ -1830,7 +2062,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1848,7 +2082,9 @@ }, { "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" : "", @@ -1866,7 +2102,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1884,7 +2122,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.TextItem.json b/docs/symbols/Roo.form.TextItem.json index 055660ee80..3a3929fcc6 100644 --- a/docs/symbols/Roo.form.TextItem.json +++ b/docs/symbols/Roo.form.TextItem.json @@ -23,86 +23,81 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "tag", "type" : "String", "desc" : "the tag for this item (default div)", - "memberOf" : "Roo.form.TextItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "html", "type" : "String", "desc" : "the content for this item", - "memberOf" : "Roo.form.TextItem", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "width", "type" : "Number", "desc" : "width (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "height", "type" : "Number", "desc" : "height (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -115,15 +110,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -142,29 +142,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -189,15 +199,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -216,15 +231,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -255,15 +275,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -276,15 +301,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -296,15 +326,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -323,15 +358,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -350,15 +390,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -370,15 +415,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -391,43 +441,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -440,15 +505,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -460,15 +530,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -487,15 +562,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -507,15 +587,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -527,15 +612,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -554,15 +644,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -574,15 +669,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -594,29 +694,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -647,15 +757,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -680,15 +795,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -701,15 +821,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -722,15 +847,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -755,15 +885,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -788,15 +923,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -815,15 +955,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -848,15 +993,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -889,7 +1039,9 @@ "events" : [ { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -919,7 +1071,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -961,7 +1115,9 @@ }, { "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" : "", @@ -979,7 +1135,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -997,7 +1155,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1015,7 +1175,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1033,7 +1195,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1051,7 +1215,9 @@ }, { "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" : "", @@ -1069,7 +1235,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1087,7 +1255,9 @@ }, { "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" : "", @@ -1105,7 +1275,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1123,7 +1295,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.TriggerField.json b/docs/symbols/Roo.form.TriggerField.json index d73b6fd39d..561329a382 100644 --- a/docs/symbols/Roo.form.TriggerField.json +++ b/docs/symbols/Roo.form.TriggerField.json @@ -25,324 +25,285 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "triggerClass", "type" : "String", "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be appended if specified.", - "memberOf" : "Roo.form.TriggerField", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "disableKeyFilter", "type" : "Boolean", "desc" : "True to disable input keystroke filtering (defaults to false)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "disabled", "type" : "Boolean", "desc" : "True to disable the field (defaults to false).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validator", "type" : "Function", "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "name", "type" : "String", "desc" : "The field's HTML name attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "width", "type" : "Number", "desc" : "width (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "regexText", "type" : "String", "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "height", "type" : "Number", "desc" : "height (optional) size of component", - "memberOf" : "Roo.BoxComponent", - "optvals" : [] + "memberOf" : "Roo.BoxComponent" }, { "name" : "value", "type" : "Mixed", "desc" : "A value to initialize this field with.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "emptyText", "type" : "String", "desc" : "The default text to display in an empty field - placeholder... (defaults to null).", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "msgFx", "type" : "String", "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "msgTarget", "type" : "String", "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n
", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maxLengthText", "type" : "String", "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "minLengthText", "type" : "String", "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "listeners", "type" : "Object", "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", - "memberOf" : "Roo.util.Observable", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "readOnly", "type" : "Boolean", "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "hideTrigger", "type" : "Boolean", "desc" : "True to hide the trigger element and display only the base text field (defaults to false)", - "memberOf" : "Roo.form.TriggerField", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the field's underlying element.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "inputType", "type" : "String", "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldClass", "type" : "String", "desc" : "The default CSS class for the field (defaults to \"x-form-field\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "allowLeadingSpace", "type" : "Boolean", "desc" : "True to prevent the stripping of leading white space", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "autoCreate", "type" : "String/Object", "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"16\", autocomplete: \"off\"})", - "memberOf" : "Roo.form.TriggerField", - "optvals" : [] + "memberOf" : "" }, { "name" : "invalidClass", "type" : "String", "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maskRe", "type" : "String", "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "vtype", "type" : "String", "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "fieldLabel", "type" : "String", "desc" : "Label to use when rendering a form.", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "blankText", "type" : "String", "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "selectOnFocus", "type" : "Boolean", "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "tabIndex", "type" : "Number", "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "regex", "type" : "RegExp", "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "minLength", "type" : "Number", "desc" : "Minimum input field length required (defaults to 0)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "allowBlank", "type" : "Boolean", "desc" : "False to validate that the value length > 0 (defaults to true)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "qtip", "type" : "String", "desc" : "Mouse over tip", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" }, { "name" : "maxLength", "type" : "Number", "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)", - "memberOf" : "Roo.form.TextField", - "optvals" : [] + "memberOf" : "Roo.form.TextField" }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", - "memberOf" : "Roo.form.Field", - "optvals" : [] + "memberOf" : "Roo.form.Field" } ], "methods" : [ { "name" : "onTriggerClick", + "type" : "function", "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.", + "sig" : "(e)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TriggerField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -355,29 +316,39 @@ }, { "name" : "autoSize", + "type" : "function", "desc" : "", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TriggerField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "selectText", + "type" : "function", "desc" : "Selects text in this field", + "sig" : "(start, end)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "start", @@ -396,15 +367,20 @@ }, { "name" : "validateValue", + "type" : "function", "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -423,29 +399,39 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.TextField", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -457,15 +443,20 @@ }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -477,15 +468,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -498,15 +494,20 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -518,15 +519,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -539,15 +545,20 @@ }, { "name" : "getRawValue", + "type" : "function", "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -559,15 +570,20 @@ }, { "name" : "applyTo", + "type" : "function", "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -586,43 +602,58 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isDirty", + "type" : "function", "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -635,29 +666,39 @@ }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isValid", + "type" : "function", "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "preventMark", @@ -676,29 +717,39 @@ }, { "name" : "hasChanged", + "type" : "function", "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -711,15 +762,20 @@ }, { "name" : "setPagePosition", + "type" : "function", "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -738,29 +794,39 @@ }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -785,15 +851,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -812,15 +883,20 @@ }, { "name" : "onResize", + "type" : "function", "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -851,15 +927,20 @@ }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -872,15 +953,20 @@ }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -892,15 +978,20 @@ }, { "name" : "onPosition", + "type" : "function", "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -919,15 +1010,20 @@ }, { "name" : "setPosition", + "type" : "function", "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -946,15 +1042,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -966,15 +1067,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -987,43 +1093,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -1036,15 +1157,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1056,15 +1182,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -1083,15 +1214,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1103,15 +1239,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1123,15 +1264,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1150,15 +1296,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1170,15 +1321,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1190,29 +1346,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1243,15 +1409,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1276,15 +1447,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1297,15 +1473,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1318,15 +1499,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1351,15 +1537,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1384,15 +1575,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1411,15 +1607,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1444,15 +1645,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1485,7 +1691,9 @@ "events" : [ { "name" : "autosize", + "type" : "function", "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.", + "sig" : "function (_self, width)\n{\n\n}", "memberOf" : "Roo.form.TextField", "example" : "", "deprecated" : "", @@ -1509,7 +1717,9 @@ }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1527,7 +1737,9 @@ }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1545,7 +1757,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1569,7 +1783,9 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1587,7 +1803,9 @@ }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1611,7 +1829,9 @@ }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1635,7 +1855,9 @@ }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1665,7 +1887,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1695,7 +1919,9 @@ }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1737,7 +1963,9 @@ }, { "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" : "", @@ -1755,7 +1983,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1773,7 +2003,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1791,7 +2023,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1809,7 +2043,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1827,7 +2063,9 @@ }, { "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" : "", @@ -1845,7 +2083,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1863,7 +2103,9 @@ }, { "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" : "", @@ -1881,7 +2123,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1899,7 +2143,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.form.VTypes.json b/docs/symbols/Roo.form.VTypes.json index 883356b8ce..712c3dfcd8 100644 --- a/docs/symbols/Roo.form.VTypes.json +++ b/docs/symbols/Roo.form.VTypes.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "email'", + "type" : "function", "desc" : "The function used to validate email addresses", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.VTypes", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -37,15 +44,20 @@ }, { "name" : "url'", + "type" : "function", "desc" : "The function used to validate URLs", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.VTypes", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -58,15 +70,20 @@ }, { "name" : "alpha'", + "type" : "function", "desc" : "The function used to validate alpha values", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.VTypes", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -79,15 +96,20 @@ }, { "name" : "alphanum'", + "type" : "function", "desc" : "The function used to validate alphanumeric values", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.VTypes", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", diff --git a/docs/symbols/Roo.form.json b/docs/symbols/Roo.form.json index b0640a32f7..fca040fccb 100644 --- a/docs/symbols/Roo.form.json +++ b/docs/symbols/Roo.form.json @@ -12,6 +12,8 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.grid.AbstractGridView.json b/docs/symbols/Roo.grid.AbstractGridView.json index ce5ed7b6ee..9c71eda8c9 100644 --- a/docs/symbols/Roo.grid.AbstractGridView.json +++ b/docs/symbols/Roo.grid.AbstractGridView.json @@ -1,18 +1,411 @@ { "name" : "Roo.grid.AbstractGridView", - "augments" : [], - "desc" : "", + "augments" : [ + "Roo.util.Observable" + ], + "desc" : "Abstract base class for grid Views", "isSingleton" : false, - "isStatic" : true, + "isStatic" : false, "isBuiltin" : false, - "memberOf" : "Roo.grid.AbstractGridView", + "memberOf" : "AbstractGridView", "example" : "", "deprecated" : "", "since" : "", "see" : "", "params" : [], "returns" : [], - "config" : [], - "methods" : [], + "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" + } + ], + "methods" : [ + { + "name" : "setCSSStyle", + "type" : "function", + "desc" : "Set a css style for a column dynamically.", + "sig" : "(colIndex, name, value)", + "static" : false, + "memberOf" : "", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "exceptions" : "", + "requires" : "", + "params" : [ + { + "name" : "colIndex", + "type" : "Number", + "desc" : "The index of the column", + "isOptional" : false + }, + { + "name" : "name", + "type" : "String", + "desc" : "The css property name", + "isOptional" : false + }, + { + "name" : "value", + "type" : "String", + "desc" : "The css value", + "isOptional" : false + } + ], + "returns" : [] + }, + { + "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
  • scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.
  • \n
  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
  • \n
  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
  • \n
  • buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is not invoked, but the new handler is scheduled in its place.
  • \n

\n

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

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

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

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

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

\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t
", + "isOptional" : false + } + ], + "returns" : [] + } + ], "events" : [] } \ No newline at end of file diff --git a/docs/symbols/Roo.grid.AbstractSelectionModel.json b/docs/symbols/Roo.grid.AbstractSelectionModel.json index 3e11272fa4..ca6d462fd2 100644 --- a/docs/symbols/Roo.grid.AbstractSelectionModel.json +++ b/docs/symbols/Roo.grid.AbstractSelectionModel.json @@ -14,41 +14,52 @@ "see" : "", "params" : [], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" } ], "methods" : [ { "name" : "lock", + "type" : "function", "desc" : "Locks the selections.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.AbstractSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isLocked", + "type" : "function", "desc" : "Returns true if the selections are locked.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.AbstractSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -60,43 +71,58 @@ }, { "name" : "unlock", + "type" : "function", "desc" : "Unlocks the selections.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.AbstractSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -127,15 +153,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -160,15 +191,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -181,15 +217,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -202,15 +243,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -235,15 +281,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -268,15 +319,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -295,15 +351,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -328,15 +389,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", diff --git a/docs/symbols/Roo.grid.Calendar.json b/docs/symbols/Roo.grid.Calendar.json index 6daa9e2175..12b8ec6075 100644 --- a/docs/symbols/Roo.grid.Calendar.json +++ b/docs/symbols/Roo.grid.Calendar.json @@ -25,27 +25,33 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "eventStore", "type" : "Store", "desc" : "The store that loads events.", - "memberOf" : "Roo.grid.Calendar", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "getSelectionModel", + "type" : "function", "desc" : "Returns the grid's SelectionModel.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Calendar", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -59,8 +65,10 @@ "events" : [ { "name" : "eventclick", + "type" : "function", "desc" : "Fires when the mouse click an", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (_self, )\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -83,8 +91,10 @@ }, { "name" : "select", + "type" : "function", "desc" : "Fires when a date is selected", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -107,8 +117,10 @@ }, { "name" : "mouseout", + "type" : "function", "desc" : "The raw mouseout event for the entire grid.", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -125,8 +137,10 @@ }, { "name" : "monthchange", + "type" : "function", "desc" : "Fires when the displayed month changes", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (_self, date)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -149,8 +163,10 @@ }, { "name" : "dragdrop", + "type" : "function", "desc" : "Fires when dragged row(s) are dropped on a valid DD target", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -185,8 +201,10 @@ }, { "name" : "rowclick", + "type" : "function", "desc" : "Fires when a row is clicked", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -215,8 +233,10 @@ }, { "name" : "headerclick", + "type" : "function", "desc" : "Fires when a header is clicked", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -245,8 +265,10 @@ }, { "name" : "startdrag", + "type" : "function", "desc" : "Fires when row(s) start being dragged", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (_self, dd, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -275,8 +297,10 @@ }, { "name" : "enddrag", + "type" : "function", "desc" : "Fires when a drag operation is complete", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (_self, dd, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -305,8 +329,10 @@ }, { "name" : "headerdblclick", + "type" : "function", "desc" : "Fires when a header cell is double clicked", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -335,8 +361,10 @@ }, { "name" : "dragenter", + "type" : "function", "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -371,8 +399,10 @@ }, { "name" : "keydown", + "type" : "function", "desc" : "The raw keydown event for the entire grid.", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -389,8 +419,10 @@ }, { "name" : "dblclick", + "type" : "function", "desc" : "The raw dblclick event for the entire grid.", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -407,8 +439,10 @@ }, { "name" : "dragout", + "type" : "function", "desc" : "Fires when the dragged row(s) leave another DD target while being dragged", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -443,8 +477,10 @@ }, { "name" : "columnmove", + "type" : "function", "desc" : "Fires when the user moves a column", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (oldIndex, newIndex)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -467,8 +503,10 @@ }, { "name" : "mouseup", + "type" : "function", "desc" : "The raw mouseup event for the entire grid.", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -485,8 +523,10 @@ }, { "name" : "eventrender", + "type" : "function", "desc" : "Fires before each cell is rendered, so you can modify the contents, like cls / title / qtip", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (_self, data)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -509,8 +549,10 @@ }, { "name" : "bodyscroll", + "type" : "function", "desc" : "Fires when the body element is scrolled", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (scrollLeft, scrollTop)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -533,8 +575,10 @@ }, { "name" : "rowdblclick", + "type" : "function", "desc" : "Fires when a row is double clicked", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -563,8 +607,10 @@ }, { "name" : "cellclick", + "type" : "function", "desc" : "Fires when a cell is clicked", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -599,8 +645,10 @@ }, { "name" : "evententer", + "type" : "function", "desc" : "Fires when mouse over an event", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (_self, Event)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -623,8 +671,10 @@ }, { "name" : "mousedown", + "type" : "function", "desc" : "The raw mousedown event for the entire grid.", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -641,8 +691,10 @@ }, { "name" : "click", + "type" : "function", "desc" : "The raw click event for the entire grid.", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -659,8 +711,10 @@ }, { "name" : "contextmenu", + "type" : "function", "desc" : "The raw contextmenu event for the entire grid.", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -677,8 +731,10 @@ }, { "name" : "eventleave", + "type" : "function", "desc" : "Fires when the mouse leaves an", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (_self, )\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -701,8 +757,10 @@ }, { "name" : "dragover", + "type" : "function", "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -737,8 +795,10 @@ }, { "name" : "rowcontextmenu", + "type" : "function", "desc" : "Fires when a row is right clicked", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -767,8 +827,10 @@ }, { "name" : "celldblclick", + "type" : "function", "desc" : "Fires when a cell is double clicked", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -803,8 +865,10 @@ }, { "name" : "headercontextmenu", + "type" : "function", "desc" : "Fires when a header is right clicked", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -833,8 +897,10 @@ }, { "name" : "rowclass", + "type" : "function", "desc" : "Fires when a row is rendered, so you can change add a style to it.", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (gridview, rowcfg)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -857,8 +923,10 @@ }, { "name" : "mouseover", + "type" : "function", "desc" : "The raw mouseover event for the entire grid.", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -875,8 +943,10 @@ }, { "name" : "keypress", + "type" : "function", "desc" : "The raw keypress event for the entire grid.", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -893,8 +963,10 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires when the grid is rendered", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (grid)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -911,8 +983,10 @@ }, { "name" : "columnresize", + "type" : "function", "desc" : "Fires when the user resizes a column", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (columnIndex, newSize)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -935,8 +1009,10 @@ }, { "name" : "cellcontextmenu", + "type" : "function", "desc" : "Fires when a cell is right clicked", - "memberOf" : "Roo.grid.Calendar", + "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.grid.CellSelectionModel.json b/docs/symbols/Roo.grid.CellSelectionModel.json index 3cae2bedd7..601ff28034 100644 --- a/docs/symbols/Roo.grid.CellSelectionModel.json +++ b/docs/symbols/Roo.grid.CellSelectionModel.json @@ -22,34 +22,39 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "enter_is_tab", "type" : "Boolean", "desc" : "Enter behaves the same as tab. (eg. goes to next cell) default: false", - "memberOf" : "Roo.grid.CellSelectionModel", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "hasSelection", + "type" : "function", "desc" : "Returns true if there is a selection.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.CellSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -61,15 +66,20 @@ }, { "name" : "onEditorKey", + "type" : "function", "desc" : "Selects a cell.", + "sig" : "(field, e)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.CellSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "field", @@ -88,15 +98,20 @@ }, { "name" : "select", + "type" : "function", "desc" : "Selects a cell.", + "sig" : "(rowIndex, collIndex)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.CellSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "rowIndex", @@ -115,15 +130,20 @@ }, { "name" : "getSelectedCell", + "type" : "function", "desc" : "Returns the currently selected cell,.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.CellSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -135,15 +155,20 @@ }, { "name" : "clearSelections", + "type" : "function", "desc" : "Clears all selections.", + "sig" : "(true)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.CellSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "true", @@ -156,29 +181,39 @@ }, { "name" : "lock", + "type" : "function", "desc" : "Locks the selections.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.AbstractSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isLocked", + "type" : "function", "desc" : "Returns true if the selections are locked.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.AbstractSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -190,43 +225,58 @@ }, { "name" : "unlock", + "type" : "function", "desc" : "Unlocks the selections.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.AbstractSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -257,15 +307,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -290,15 +345,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -311,15 +371,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -332,15 +397,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -365,15 +435,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -398,15 +473,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -425,15 +505,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -458,15 +543,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -499,8 +589,10 @@ "events" : [ { "name" : "beforeeditnext", + "type" : "function", "desc" : "Fires before the next editable sell is made active\nYou can use this to skip to another cell or fire the tabend\n if you set cell to false", - "memberOf" : "Roo.grid.CellSelectionModel", + "sig" : "function (eventdata)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -517,8 +609,10 @@ }, { "name" : "cellselect", + "type" : "function", "desc" : "Fires when a cell is selected.", - "memberOf" : "Roo.grid.CellSelectionModel", + "sig" : "function (_self, rowIndex, colIndex)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -547,8 +641,10 @@ }, { "name" : "tabend", + "type" : "function", "desc" : "Fires when the tab (or enter) was pressed on the last editable cell\nYou can use this to trigger add new row.", - "memberOf" : "Roo.grid.CellSelectionModel", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -565,8 +661,10 @@ }, { "name" : "selectionchange", + "type" : "function", "desc" : "Fires when the active selection changes.", - "memberOf" : "Roo.grid.CellSelectionModel", + "sig" : "function (_self, selection)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -589,8 +687,10 @@ }, { "name" : "beforerowselect", + "type" : "function", "desc" : "Fires before a cell is selected.", - "memberOf" : "Roo.grid.CellSelectionModel", + "sig" : "function (_self, rowIndex, colIndex)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.grid.ColumnModel.json b/docs/symbols/Roo.grid.ColumnModel.json index 319c946fce..98f3140e49 100644 --- a/docs/symbols/Roo.grid.ColumnModel.json +++ b/docs/symbols/Roo.grid.ColumnModel.json @@ -21,195 +21,177 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "mdHeader", "type" : "String", "desc" : "Header at Bootsrap Medium width", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "memberOf" : "" }, { "name" : "editor", "type" : "Roo.grid.GridEditor", "desc" : "(Optional) For grid editors - returns the grid editor", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "memberOf" : "" }, { "name" : "cursor", "type" : "String", "desc" : "(Optional)", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "smHeader", "type" : "String", "desc" : "Header at Bootsrap Small width", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "memberOf" : "" }, { "name" : "tooltip", "type" : "String", "desc" : "(Optional)", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "memberOf" : "" }, { "name" : "md", "type" : "Number", "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "memberOf" : "" }, { "name" : "align", "type" : "String", "desc" : "(Optional) Set the CSS text-align property of the column. Defaults to undefined.", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "memberOf" : "" }, { "name" : "lgHeader", "type" : "String", "desc" : "Header at Bootsrap Large width", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "memberOf" : "" }, { "name" : "xlHeader", "type" : "String", "desc" : "Header at Bootsrap extra Large width", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "memberOf" : "" }, { "name" : "fixed", "type" : "Boolean", "desc" : "(Optional) True if the column width cannot be changed. Defaults to false.", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "memberOf" : "" }, { "name" : "hidden", "type" : "Boolean", "desc" : "(Optional) True to hide the column. Defaults to false.", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "memberOf" : "" }, { "name" : "valign", "type" : "String", "desc" : "(Optional) Set the CSS vertical-align property of the column (eg. middle, top, bottom etc). Defaults to undefined.", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "memberOf" : "" }, { "name" : "locked", "type" : "Boolean", "desc" : "(Optional) True to lock the column in place while scrolling the Grid. Defaults to false.", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "memberOf" : "" }, { "name" : "lg", "type" : "Number", "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "memberOf" : "" }, { "name" : "renderer", "type" : "Function", "desc" : "(Optional) A function used to generate HTML markup for a cell\ngiven the cell's data value. See {@link #setRenderer}. If not specified, the\ndefault renderer returns the escaped data value. If an object is returned (bootstrap only)\nthen it is treated as a Roo Component object instance, and it is rendered after the initial row is rendered", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "memberOf" : "" }, { "name" : "xs", "type" : "Number", "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "memberOf" : "" }, { "name" : "xsHeader", "type" : "String", "desc" : "Header at Bootsrap Extra Small width (default for all)", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "memberOf" : "" }, { "name" : "sortable", "type" : "Boolean", "desc" : "(Optional) True if sorting is to be allowed on this column.\nDefaults to the value of the {@link #defaultSortable} property.\nWhether local/remote sorting is used is specified in {@link Roo.data.Store#remoteSort}.", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "memberOf" : "" }, { "name" : "header", "type" : "String", "desc" : "The header text to display in the Grid view.", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "memberOf" : "" }, { "name" : "width", "type" : "Number", "desc" : "(Optional) The initial width in pixels of the column. Using this\ninstead of {@link Roo.grid.Grid#autoSizeColumns} is more efficient.", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "memberOf" : "" }, { "name" : "resizable", "type" : "Boolean", "desc" : "(Optional) False to disable column resizing. Defaults to true.", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "memberOf" : "" }, { "name" : "xl", "type" : "Number", "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataIndex", "type" : "String", "desc" : "(Optional) The name of the field in the grid's {@link Roo.data.Store}'s\n{@link Roo.data.Record} definition from which to draw the column's value. If not\nspecified, the column's index is used as an index into the Record's data Array.", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "memberOf" : "" }, { "name" : "sm", "type" : "Number", "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)", - "memberOf" : "Roo.grid.ColumnModel", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "setRenderer", + "type" : "function", "desc" : "Sets the rendering (formatting) function for a column.", + "sig" : "(col, fn)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "col", @@ -228,15 +210,20 @@ }, { "name" : "isHidden", + "type" : "function", "desc" : "Returns true if the column is hidden.", + "sig" : "(colIndex)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "colIndex", @@ -255,15 +242,20 @@ }, { "name" : "setColumnHeader", + "type" : "function", "desc" : "Sets the header for a column.", + "sig" : "(col, header)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "col", @@ -282,15 +274,20 @@ }, { "name" : "getColumnCount", + "type" : "function", "desc" : "Returns the number of columns.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -302,15 +299,20 @@ }, { "name" : "addColumn", + "type" : "function", "desc" : "Add a column (experimental...) - defaults to adding to the end..", + "sig" : "(config)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -323,15 +325,20 @@ }, { "name" : "getColumnHeader", + "type" : "function", "desc" : "Returns the header for the specified column.", + "sig" : "(col)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "col", @@ -350,15 +357,20 @@ }, { "name" : "getRenderer", + "type" : "function", "desc" : "Returns the rendering (formatting) function defined for the column.", + "sig" : "(col)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "col", @@ -377,15 +389,20 @@ }, { "name" : "getColumnTooltip", + "type" : "function", "desc" : "Returns the tooltip for the specified column.", + "sig" : "(col)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "col", @@ -404,15 +421,20 @@ }, { "name" : "setColumnWidth", + "type" : "function", "desc" : "Sets the width for a column.", + "sig" : "(col, width)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "col", @@ -431,15 +453,20 @@ }, { "name" : "setDataIndex", + "type" : "function", "desc" : "Sets the dataIndex for a column.", + "sig" : "(col, dataIndex)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "col", @@ -458,15 +485,20 @@ }, { "name" : "isCellEditable", + "type" : "function", "desc" : "Returns true if the cell is editable.", + "sig" : "(colIndex, rowIndex)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "colIndex", @@ -491,15 +523,20 @@ }, { "name" : "getColumnsBy", + "type" : "function", "desc" : "Returns the column configs that return true by the passed function that is called with (columnConfig, index)", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -524,15 +561,20 @@ }, { "name" : "getColumnWidth", + "type" : "function", "desc" : "Returns the width for the specified column.", + "sig" : "(col, (optional))", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "col", @@ -557,29 +599,39 @@ }, { "name" : "isFixed", + "type" : "function", "desc" : "Returns true if the column width cannot be changed", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getCellEditor", + "type" : "function", "desc" : "Returns the editor defined for the cell/column.\nreturn false or null to disable editing.", + "sig" : "(colIndex, rowIndex)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "colIndex", @@ -604,15 +656,20 @@ }, { "name" : "getColumnId", + "type" : "function", "desc" : "Returns the id of the column at the specified index.", + "sig" : "(index)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -631,15 +688,20 @@ }, { "name" : "getDataIndex", + "type" : "function", "desc" : "Returns the dataIndex for the specified column.", + "sig" : "(col)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "col", @@ -658,15 +720,20 @@ }, { "name" : "isResizable", + "type" : "function", "desc" : "Returns true if the column can be resized", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -678,15 +745,20 @@ }, { "name" : "setColumnTooltip", + "type" : "function", "desc" : "Sets the tooltip for a column.", + "sig" : "(col, tooltip)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "col", @@ -705,15 +777,20 @@ }, { "name" : "setHidden", + "type" : "function", "desc" : "Sets if a column is hidden.", + "sig" : "(colIndex, hidden)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "colIndex", @@ -732,15 +809,20 @@ }, { "name" : "setEditable", + "type" : "function", "desc" : "Sets if a column is editable.", + "sig" : "(col, editable)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "col", @@ -759,15 +841,20 @@ }, { "name" : "getColumnById", + "type" : "function", "desc" : "Returns the column for a specified id.", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -786,15 +873,20 @@ }, { "name" : "getColumnByDataIndex", + "type" : "function", "desc" : "Returns the column Object for a specified dataIndex.", + "sig" : "(dataIndex)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "dataIndex", @@ -813,15 +905,20 @@ }, { "name" : "setEditor", + "type" : "function", "desc" : "Sets the editor for a column.", + "sig" : "(col, editor)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "col", @@ -840,15 +937,20 @@ }, { "name" : "findColumnIndex", + "type" : "function", "desc" : "Returns the index for a specified column dataIndex.", + "sig" : "(dataIndex)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "dataIndex", @@ -867,15 +969,20 @@ }, { "name" : "isSortable", + "type" : "function", "desc" : "Returns true if the specified column is sortable.", + "sig" : "(col)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "col", @@ -894,15 +1001,20 @@ }, { "name" : "getIndexById", + "type" : "function", "desc" : "Returns the index for a specified column id.", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -921,15 +1033,20 @@ }, { "name" : "getTotalWidth", + "type" : "function", "desc" : "Returns the total width of all columns.", + "sig" : "(includeHidden)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.ColumnModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "includeHidden", @@ -948,29 +1065,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1001,15 +1128,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1034,15 +1166,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1055,15 +1192,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1076,15 +1218,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1109,15 +1256,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1142,15 +1294,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1169,15 +1326,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1202,15 +1364,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1243,8 +1410,10 @@ "events" : [ { "name" : "hiddenchange", + "type" : "function", "desc" : "Fires when a column is hidden or \"unhidden\".", - "memberOf" : "Roo.grid.ColumnModel", + "sig" : "function (_self, columnIndex, hidden)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1273,8 +1442,10 @@ }, { "name" : "headerchange", + "type" : "function", "desc" : "Fires when the text of a header changes.", - "memberOf" : "Roo.grid.ColumnModel", + "sig" : "function (_self, columnIndex, newText)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1303,8 +1474,10 @@ }, { "name" : "columlockchange", + "type" : "function", "desc" : "Fires when a column's locked state is changed", - "memberOf" : "Roo.grid.ColumnModel", + "sig" : "function (_self, colIndex, locked)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1333,8 +1506,10 @@ }, { "name" : "columnmoved", + "type" : "function", "desc" : "Fires when a column is moved.", - "memberOf" : "Roo.grid.ColumnModel", + "sig" : "function (_self, oldIndex, newIndex)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1363,8 +1538,10 @@ }, { "name" : "widthchange", + "type" : "function", "desc" : "Fires when the width of a column changes.", - "memberOf" : "Roo.grid.ColumnModel", + "sig" : "function (_self, columnIndex, newWidth)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.grid.EditorGrid.json b/docs/symbols/Roo.grid.EditorGrid.json index ea36c9df12..3911cb4b1f 100644 --- a/docs/symbols/Roo.grid.EditorGrid.json +++ b/docs/symbols/Roo.grid.EditorGrid.json @@ -34,223 +34,232 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "autoSizeColumns", "type" : "Boolean", "desc" : "True to automatically resize the columns to fit their content\non initial render. It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "cm[]", + "type" : "Roo.grid.ColumnModel", + "desc" : "The columns of the grid", + "memberOf" : "Roo.grid.Grid" }, { "name" : "maxRowsToMeasure", "type" : "Boolean", "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" }, { "name" : "minColumnWidth", "type" : "Number", "desc" : "The minimum width a column can be resized to. Default is 25.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" }, { "name" : "ddText", "type" : "String", "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "toolbar", + "type" : "Roo.Toolbar", + "desc" : "a toolbar for buttons etc.", + "memberOf" : "Roo.grid.Grid" }, { "name" : "autoExpandColumn", "type" : "String", "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" }, { "name" : "autoExpandMax", "type" : "Number", "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" }, { "name" : "enableRowHeightSync", "type" : "Boolean", "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" }, { "name" : "enableDrop", "type" : "Boolean", "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" }, { "name" : "monitorWindowResize", "type" : "Boolean", "desc" : "True to autoSize the grid when the window resizes. Default is true.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" }, { "name" : "autoExpandMin", "type" : "Number", "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" }, { "name" : "view", - "type" : "Object", - "desc" : "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "type" : "Roo.grid.GridView", + "desc" : "The view that renders the grid (default = Roo.grid.GridView)", + "memberOf" : "Roo.grid.Grid" }, { - "name" : "enableDrag", - "type" : "Boolean", - "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "name" : "ds", + "type" : "Roo.grid.Store", + "desc" : "The data store for the grid", + "memberOf" : "Roo.grid.Grid" }, { "name" : "ddGroup", "type" : "String", "desc" : "- drag drop group.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "enableDrag", + "type" : "Boolean", + "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)", + "memberOf" : "Roo.grid.Grid" }, { "name" : "autoWidth", "type" : "Boolean", "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" }, { "name" : "maxHeight", "type" : "Number", "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" }, { "name" : "trackMouseOver", "type" : "Boolean", "desc" : "True to highlight rows when the mouse is over. Default is true.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" }, { "name" : "loadMask", "type" : "Object", "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" }, { "name" : "stripeRows", "type" : "Boolean", "desc" : "True to stripe the rows. Default is true.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" }, { "name" : "enableColumnMove", "type" : "Boolean", "desc" : "True to enable drag and drop reorder of columns. Default is true.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" }, { "name" : "enableColumnHide", "type" : "Boolean", "desc" : "True to enable hiding of columns with the header context menu. Default is true.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" }, { "name" : "clicksToEdit", "type" : "Number", "desc" : "The number of clicks on a cell required to display the cell's editor (defaults to 2)", - "memberOf" : "Roo.grid.EditorGrid", - "optvals" : [] + "memberOf" : "" }, { "name" : "autoSizeHeaders", "type" : "Boolean", "desc" : "True to measure headers with column data when auto sizing columns. Default is true.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" }, { "name" : "enableDragDrop", "type" : "Boolean", "desc" : "True to enable drag and drop of rows. Default is false.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" }, { "name" : "dropTarget", "type" : "Roo.dd.DropTarget", "desc" : "An {@link Roo.dd.DropTarget} config", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "sm", + "type" : "Roo.grid.AbstractSelectionModel", + "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)", + "memberOf" : "Roo.grid.Grid" }, { "name" : "dragGroup", "type" : "String", "desc" : "- drag group (?? not sure if needed.)", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" }, { "name" : "autoHeight", "type" : "Boolean", "desc" : "True to fit the height of the grid container to the height of the data. Default is false.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" } ], "methods" : [ { "name" : "stopEditing", + "type" : "function", "desc" : "Stops any active editing", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.EditorGrid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getDragDropText", + "type" : "function", "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.EditorGrid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -262,15 +271,20 @@ }, { "name" : "startEditing", + "type" : "function", "desc" : "Starts editing the specified for the specified row/column", + "sig" : "(rowIndex, colIndex)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.EditorGrid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "rowIndex", @@ -289,15 +303,20 @@ }, { "name" : "getSelectionModel", + "type" : "function", "desc" : "Returns the grid's SelectionModel.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -309,15 +328,20 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Destroy this grid.", + "sig" : "(removeEl)", + "static" : false, + "memberOf" : "Roo.grid.Grid", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "removeEl", @@ -330,15 +354,20 @@ }, { "name" : "getColumnModel", + "type" : "function", "desc" : "Returns the grid's ColumnModel.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -350,15 +379,20 @@ }, { "name" : "getGridEl", + "type" : "function", "desc" : "Returns the grid's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -370,15 +404,20 @@ }, { "name" : "getDataSource", + "type" : "function", "desc" : "Returns the grid's DataSource.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -390,29 +429,39 @@ }, { "name" : "autoSize", + "type" : "function", "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getView", + "type" : "function", "desc" : "Returns the grid's GridView object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -424,15 +473,20 @@ }, { "name" : "reconfigure", + "type" : "function", "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.", + "sig" : "(dataSource, The)", + "static" : false, + "memberOf" : "Roo.grid.Grid", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "dataSource", @@ -451,15 +505,20 @@ }, { "name" : "addColumns", + "type" : "function", "desc" : "addColumns\nAdd's a column, default at the end..", + "sig" : "(position, of)", + "static" : false, + "memberOf" : "Roo.grid.Grid", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "position", @@ -478,15 +537,20 @@ }, { "name" : "render", + "type" : "function", "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -498,29 +562,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -551,15 +625,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -584,15 +663,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -605,15 +689,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -626,15 +715,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -659,15 +753,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -692,15 +791,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -719,15 +823,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -752,15 +861,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -793,8 +907,10 @@ "events" : [ { "name" : "validateedit", + "type" : "function", "desc" : "Fires after a cell is edited, but before the value is set in the record. \nYou can use this to modify the value being set in the field, Return false\nto cancel the change. The edit event object has the following properties
\n
    \n
  • editor - This editor
  • \n
  • grid - This grid
  • \n
  • record - The record being edited
  • \n
  • field - The field name being edited
  • \n
  • value - The value being set
  • \n
  • originalValue - The original value for the field, before the edit.
  • \n
  • row - The grid row index
  • \n
  • column - The grid column index
  • \n
  • cancel - Set this to true to cancel the edit or return false from your handler.
  • \n
", - "memberOf" : "Roo.grid.EditorGrid", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -811,8 +927,10 @@ }, { "name" : "beforeedit", + "type" : "function", "desc" : "Fires before cell editing is triggered. The edit event object has the following properties
\n
    \n
  • grid - This grid
  • \n
  • record - The record being edited
  • \n
  • field - The field name being edited
  • \n
  • value - The value for the field being edited.
  • \n
  • row - The grid row index
  • \n
  • column - The grid column index
  • \n
  • cancel - Set this to true to cancel the edit or return false from your handler.
  • \n
", - "memberOf" : "Roo.grid.EditorGrid", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -829,8 +947,10 @@ }, { "name" : "afteredit", + "type" : "function", "desc" : "Fires after a cell is edited.
\n
    \n
  • grid - This grid
  • \n
  • record - The record being edited
  • \n
  • field - The field name being edited
  • \n
  • value - The value being set
  • \n
  • originalValue - The original value for the field, before the edit.
  • \n
  • row - The grid row index
  • \n
  • column - The grid column index
  • \n
", - "memberOf" : "Roo.grid.EditorGrid", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -847,7 +967,9 @@ }, { "name" : "rowcontextmenu", + "type" : "function", "desc" : "Fires when a row is right clicked", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -877,7 +999,9 @@ }, { "name" : "columnmove", + "type" : "function", "desc" : "Fires when the user moves a column", + "sig" : "function (oldIndex, newIndex)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -901,7 +1025,9 @@ }, { "name" : "headercontextmenu", + "type" : "function", "desc" : "Fires when a header is right clicked", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -931,7 +1057,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires when the grid is rendered", + "sig" : "function (grid)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -949,7 +1077,9 @@ }, { "name" : "bodyscroll", + "type" : "function", "desc" : "Fires when the body element is scrolled", + "sig" : "function (scrollLeft, scrollTop)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -973,7 +1103,9 @@ }, { "name" : "columnresize", + "type" : "function", "desc" : "Fires when the user resizes a column", + "sig" : "function (columnIndex, newSize)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -997,7 +1129,9 @@ }, { "name" : "enddrag", + "type" : "function", "desc" : "Fires when a drag operation is complete", + "sig" : "function (_self, dd, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1027,7 +1161,9 @@ }, { "name" : "mouseout", + "type" : "function", "desc" : "The raw mouseout event for the entire grid.", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1045,7 +1181,9 @@ }, { "name" : "cellclick", + "type" : "function", "desc" : "Fires when a cell is clicked", + "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1081,7 +1219,9 @@ }, { "name" : "dragover", + "type" : "function", "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1117,7 +1257,9 @@ }, { "name" : "rowclass", + "type" : "function", "desc" : "Fires when a row is rendered, so you can change add a style to it.", + "sig" : "function (gridview, rowcfg)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1141,7 +1283,9 @@ }, { "name" : "keydown", + "type" : "function", "desc" : "The raw keydown event for the entire grid.", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1159,7 +1303,9 @@ }, { "name" : "mousedown", + "type" : "function", "desc" : "The raw mousedown event for the entire grid.", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1177,7 +1323,9 @@ }, { "name" : "dragenter", + "type" : "function", "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1213,7 +1361,9 @@ }, { "name" : "dragout", + "type" : "function", "desc" : "Fires when the dragged row(s) leave another DD target while being dragged", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1249,7 +1399,9 @@ }, { "name" : "mouseup", + "type" : "function", "desc" : "The raw mouseup event for the entire grid.", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1267,7 +1419,9 @@ }, { "name" : "keypress", + "type" : "function", "desc" : "The raw keypress event for the entire grid.", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1285,7 +1439,9 @@ }, { "name" : "headerclick", + "type" : "function", "desc" : "Fires when a header is clicked", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1315,7 +1471,9 @@ }, { "name" : "mouseover", + "type" : "function", "desc" : "The raw mouseover event for the entire grid.", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1333,7 +1491,9 @@ }, { "name" : "headerdblclick", + "type" : "function", "desc" : "Fires when a header cell is double clicked", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1363,7 +1523,9 @@ }, { "name" : "dragdrop", + "type" : "function", "desc" : "Fires when dragged row(s) are dropped on a valid DD target", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1399,7 +1561,9 @@ }, { "name" : "rowclick", + "type" : "function", "desc" : "Fires when a row is clicked", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1429,7 +1593,9 @@ }, { "name" : "click", + "type" : "function", "desc" : "The raw click event for the entire grid.", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1447,7 +1613,9 @@ }, { "name" : "rowdblclick", + "type" : "function", "desc" : "Fires when a row is double clicked", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1477,7 +1645,9 @@ }, { "name" : "startdrag", + "type" : "function", "desc" : "Fires when row(s) start being dragged", + "sig" : "function (_self, dd, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1507,7 +1677,9 @@ }, { "name" : "dblclick", + "type" : "function", "desc" : "The raw dblclick event for the entire grid.", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1525,7 +1697,9 @@ }, { "name" : "cellcontextmenu", + "type" : "function", "desc" : "Fires when a cell is right clicked", + "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1561,7 +1735,9 @@ }, { "name" : "contextmenu", + "type" : "function", "desc" : "The raw contextmenu event for the entire grid.", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1579,7 +1755,9 @@ }, { "name" : "celldblclick", + "type" : "function", "desc" : "Fires when a cell is double clicked", + "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.grid.Grid.json b/docs/symbols/Roo.grid.Grid.json index f8492f64e6..919499ffc0 100644 --- a/docs/symbols/Roo.grid.Grid.json +++ b/docs/symbols/Roo.grid.Grid.json @@ -27,202 +27,207 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "autoSizeColumns", "type" : "Boolean", "desc" : "True to automatically resize the columns to fit their content\non initial render. It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" + }, + { + "name" : "cm[]", + "type" : "Roo.grid.ColumnModel", + "desc" : "The columns of the grid", + "memberOf" : "" }, { "name" : "maxRowsToMeasure", "type" : "Boolean", "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "" }, { "name" : "minColumnWidth", "type" : "Number", "desc" : "The minimum width a column can be resized to. Default is 25.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "" }, { "name" : "ddText", "type" : "String", "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "" + }, + { + "name" : "toolbar", + "type" : "Roo.Toolbar", + "desc" : "a toolbar for buttons etc.", + "memberOf" : "" }, { "name" : "autoExpandColumn", "type" : "String", "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "" }, { "name" : "autoExpandMax", "type" : "Number", "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "" }, { "name" : "enableRowHeightSync", "type" : "Boolean", "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "" }, { "name" : "enableDrop", "type" : "Boolean", "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "" }, { "name" : "monitorWindowResize", "type" : "Boolean", "desc" : "True to autoSize the grid when the window resizes. Default is true.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "" }, { "name" : "autoExpandMin", "type" : "Number", "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "" }, { "name" : "view", - "type" : "Object", - "desc" : "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "type" : "Roo.grid.GridView", + "desc" : "The view that renders the grid (default = Roo.grid.GridView)", + "memberOf" : "" }, { - "name" : "enableDrag", - "type" : "Boolean", - "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "name" : "ds", + "type" : "Roo.grid.Store", + "desc" : "The data store for the grid", + "memberOf" : "" }, { "name" : "ddGroup", "type" : "String", "desc" : "- drag drop group.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "" + }, + { + "name" : "enableDrag", + "type" : "Boolean", + "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)", + "memberOf" : "" }, { "name" : "autoWidth", "type" : "Boolean", "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "" }, { "name" : "maxHeight", "type" : "Number", "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "" }, { "name" : "trackMouseOver", "type" : "Boolean", "desc" : "True to highlight rows when the mouse is over. Default is true.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "" }, { "name" : "loadMask", "type" : "Object", "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "" }, { "name" : "stripeRows", "type" : "Boolean", "desc" : "True to stripe the rows. Default is true.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "" }, { "name" : "enableColumnMove", "type" : "Boolean", "desc" : "True to enable drag and drop reorder of columns. Default is true.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "" }, { "name" : "enableColumnHide", "type" : "Boolean", "desc" : "True to enable hiding of columns with the header context menu. Default is true.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "" }, { "name" : "autoSizeHeaders", "type" : "Boolean", "desc" : "True to measure headers with column data when auto sizing columns. Default is true.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "" }, { "name" : "enableDragDrop", "type" : "Boolean", "desc" : "True to enable drag and drop of rows. Default is false.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "" }, { "name" : "dropTarget", "type" : "Roo.dd.DropTarget", "desc" : "An {@link Roo.dd.DropTarget} config", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "" + }, + { + "name" : "sm", + "type" : "Roo.grid.AbstractSelectionModel", + "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)", + "memberOf" : "" }, { "name" : "dragGroup", "type" : "String", "desc" : "- drag group (?? not sure if needed.)", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "" }, { "name" : "autoHeight", "type" : "Boolean", "desc" : "True to fit the height of the grid container to the height of the data. Default is false.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "getSelectionModel", + "type" : "function", "desc" : "Returns the grid's SelectionModel.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -234,15 +239,20 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Destroy this grid.", + "sig" : "(removeEl)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "removeEl", @@ -255,15 +265,20 @@ }, { "name" : "getColumnModel", + "type" : "function", "desc" : "Returns the grid's ColumnModel.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -275,15 +290,20 @@ }, { "name" : "getGridEl", + "type" : "function", "desc" : "Returns the grid's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -295,15 +315,20 @@ }, { "name" : "getDataSource", + "type" : "function", "desc" : "Returns the grid's DataSource.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -315,29 +340,39 @@ }, { "name" : "autoSize", + "type" : "function", "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getView", + "type" : "function", "desc" : "Returns the grid's GridView object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -349,15 +384,20 @@ }, { "name" : "getDragDropText", + "type" : "function", "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.\nOverride this to put something different in the dragged text.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -369,15 +409,20 @@ }, { "name" : "reconfigure", + "type" : "function", "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.", + "sig" : "(dataSource, The)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "dataSource", @@ -396,15 +441,20 @@ }, { "name" : "addColumns", + "type" : "function", "desc" : "addColumns\nAdd's a column, default at the end..", + "sig" : "(position, of)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "position", @@ -423,15 +473,20 @@ }, { "name" : "render", + "type" : "function", "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -443,29 +498,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -496,15 +561,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -529,15 +599,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -550,15 +625,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -571,15 +651,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -604,15 +689,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -637,15 +727,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -664,15 +759,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -697,15 +797,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -738,8 +843,10 @@ "events" : [ { "name" : "rowcontextmenu", + "type" : "function", "desc" : "Fires when a row is right clicked", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -768,8 +875,10 @@ }, { "name" : "columnmove", + "type" : "function", "desc" : "Fires when the user moves a column", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (oldIndex, newIndex)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -792,8 +901,10 @@ }, { "name" : "headercontextmenu", + "type" : "function", "desc" : "Fires when a header is right clicked", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -822,8 +933,10 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires when the grid is rendered", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (grid)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -840,8 +953,10 @@ }, { "name" : "bodyscroll", + "type" : "function", "desc" : "Fires when the body element is scrolled", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (scrollLeft, scrollTop)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -864,8 +979,10 @@ }, { "name" : "columnresize", + "type" : "function", "desc" : "Fires when the user resizes a column", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (columnIndex, newSize)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -888,8 +1005,10 @@ }, { "name" : "enddrag", + "type" : "function", "desc" : "Fires when a drag operation is complete", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (_self, dd, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -918,8 +1037,10 @@ }, { "name" : "mouseout", + "type" : "function", "desc" : "The raw mouseout event for the entire grid.", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -936,8 +1057,10 @@ }, { "name" : "cellclick", + "type" : "function", "desc" : "Fires when a cell is clicked", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -972,8 +1095,10 @@ }, { "name" : "dragover", + "type" : "function", "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1008,8 +1133,10 @@ }, { "name" : "rowclass", + "type" : "function", "desc" : "Fires when a row is rendered, so you can change add a style to it.", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (gridview, rowcfg)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1032,8 +1159,10 @@ }, { "name" : "keydown", + "type" : "function", "desc" : "The raw keydown event for the entire grid.", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1050,8 +1179,10 @@ }, { "name" : "mousedown", + "type" : "function", "desc" : "The raw mousedown event for the entire grid.", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1068,8 +1199,10 @@ }, { "name" : "dragenter", + "type" : "function", "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1104,8 +1237,10 @@ }, { "name" : "dragout", + "type" : "function", "desc" : "Fires when the dragged row(s) leave another DD target while being dragged", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1140,8 +1275,10 @@ }, { "name" : "mouseup", + "type" : "function", "desc" : "The raw mouseup event for the entire grid.", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1158,8 +1295,10 @@ }, { "name" : "keypress", + "type" : "function", "desc" : "The raw keypress event for the entire grid.", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1176,8 +1315,10 @@ }, { "name" : "headerclick", + "type" : "function", "desc" : "Fires when a header is clicked", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1206,8 +1347,10 @@ }, { "name" : "mouseover", + "type" : "function", "desc" : "The raw mouseover event for the entire grid.", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1224,8 +1367,10 @@ }, { "name" : "headerdblclick", + "type" : "function", "desc" : "Fires when a header cell is double clicked", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1254,8 +1399,10 @@ }, { "name" : "dragdrop", + "type" : "function", "desc" : "Fires when dragged row(s) are dropped on a valid DD target", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1290,8 +1437,10 @@ }, { "name" : "rowclick", + "type" : "function", "desc" : "Fires when a row is clicked", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1320,8 +1469,10 @@ }, { "name" : "click", + "type" : "function", "desc" : "The raw click event for the entire grid.", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1338,8 +1489,10 @@ }, { "name" : "rowdblclick", + "type" : "function", "desc" : "Fires when a row is double clicked", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1368,8 +1521,10 @@ }, { "name" : "startdrag", + "type" : "function", "desc" : "Fires when row(s) start being dragged", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (_self, dd, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1398,8 +1553,10 @@ }, { "name" : "dblclick", + "type" : "function", "desc" : "The raw dblclick event for the entire grid.", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1416,8 +1573,10 @@ }, { "name" : "cellcontextmenu", + "type" : "function", "desc" : "Fires when a cell is right clicked", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1452,8 +1611,10 @@ }, { "name" : "contextmenu", + "type" : "function", "desc" : "The raw contextmenu event for the entire grid.", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1470,8 +1631,10 @@ }, { "name" : "celldblclick", + "type" : "function", "desc" : "Fires when a cell is double clicked", - "memberOf" : "Roo.grid.Grid", + "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.grid.GridEditor.json b/docs/symbols/Roo.grid.GridEditor.json index 52b6499489..f383a812ae 100644 --- a/docs/symbols/Roo.grid.GridEditor.json +++ b/docs/symbols/Roo.grid.GridEditor.json @@ -23,142 +23,129 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "hideEl", "type" : "Boolean", "desc" : "False to keep the bound element visible while the editor is displayed (defaults to true)", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "Roo.Editor" }, { "name" : "alignment", "type" : "String", "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to \"c-c?\").", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "Roo.Editor" }, { "name" : "constrain", "type" : "Boolean", "desc" : "True to constrain the editor to the viewport", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "Roo.Editor" }, { "name" : "shadow", "type" : "Boolean/String", "desc" : "\"sides\" for sides/bottom only, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"frame\")", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "Roo.Editor" }, { "name" : "field", "type" : "Roo.form.Field", "desc" : "Field to wrap (or xtyped)", - "memberOf" : "Roo.grid.GridEditor", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "value", "type" : "Mixed", "desc" : "The data value of the underlying field (defaults to \"\")", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "Roo.Editor" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cancelOnEsc", "type" : "Boolean", "desc" : "True to cancel the edit when the escape key is pressed (defaults to false)", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "Roo.Editor" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "completeOnEnter", "type" : "Boolean", "desc" : "True to complete the edit when the enter key is pressed (defaults to false)", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "Roo.Editor" }, { "name" : "revertInvalid", "type" : "Boolean", "desc" : "True to automatically revert the field value and cancel the edit when the user completes an edit and the field\nvalidation fails (defaults to true)", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "Roo.Editor" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "ignoreNoChange", "type" : "Boolean", "desc" : "True to skip the the edit completion process (no save, no events fired) if the user completes an edit and\nthe value has not changed (defaults to false). Applies only to string values - edits for other data types\nwill never be ignored.", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "Roo.Editor" }, { "name" : "autosize", "type" : "Boolean/String", "desc" : "True for the editor to automatically adopt the size of the underlying field, \"width\" to adopt the width only,\nor \"height\" to adopt the height only (defaults to false)", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "Roo.Editor" }, { "name" : "updateEl", "type" : "Boolean", "desc" : "True to update the innerHTML of the bound element when the update completes (defaults to false)", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "Roo.Editor" } ], "methods" : [ { "name" : "cancelEdit", + "type" : "function", "desc" : "Cancels the editing process and hides the editor without persisting any changes. The field value will be\nreverted to the original starting value.", + "sig" : "(remainVisible)", + "static" : false, + "memberOf" : "Roo.Editor", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "remainVisible", @@ -171,15 +158,20 @@ }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the height and width of this editor.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.Editor", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -198,29 +190,39 @@ }, { "name" : "realign", + "type" : "function", "desc" : "Realigns the editor to the bound field based on the current alignment config value.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Editor", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getValue", + "type" : "function", "desc" : "Gets the data value of the editor", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Editor", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -232,15 +234,20 @@ }, { "name" : "completeEdit", + "type" : "function", "desc" : "Ends the editing process, persists the changed value to the underlying field, and hides the editor.", + "sig" : "(remainVisible)", + "static" : false, + "memberOf" : "Roo.Editor", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "remainVisible", @@ -253,15 +260,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets the data value of the editor", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.Editor", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -274,15 +286,20 @@ }, { "name" : "startEdit", + "type" : "function", "desc" : "Starts the editing process and shows the editor.", + "sig" : "(el, value)", + "static" : false, + "memberOf" : "Roo.Editor", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -301,15 +318,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -321,15 +343,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -342,43 +369,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -391,15 +433,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -411,15 +458,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -438,15 +490,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -458,15 +515,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -478,15 +540,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -505,15 +572,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -525,15 +597,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -545,29 +622,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -598,15 +685,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -631,15 +723,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -652,15 +749,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -673,15 +775,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -706,15 +813,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -739,15 +851,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -766,15 +883,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -799,15 +921,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -840,7 +967,9 @@ "events" : [ { "name" : "beforestartedit", + "type" : "function", "desc" : "Fires when editing is initiated, but before the value changes. Editing can be canceled by returning\nfalse from the handler of this event.", + "sig" : "function (_self, boundEl, value)\n{\n\n}", "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", @@ -870,7 +999,9 @@ }, { "name" : "beforecomplete", + "type" : "function", "desc" : "Fires after a change has been made to the field, but before the change is reflected in the underlying\nfield. Saving the change to the field can be canceled by returning false from the handler of this event.\nNote that if the value has not changed and ignoreNoChange = true, the editing will still end but this\nevent will not fire since no edit actually occurred.", + "sig" : "function (_self, value, startValue)\n{\n\n}", "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", @@ -900,7 +1031,9 @@ }, { "name" : "complete", + "type" : "function", "desc" : "Fires after editing is complete and any changed value has been written to the underlying field.", + "sig" : "function (_self, value, startValue)\n{\n\n}", "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", @@ -930,7 +1063,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", @@ -954,7 +1089,9 @@ }, { "name" : "startedit", + "type" : "function", "desc" : "Fires when this editor is displayed", + "sig" : "function (boundEl, value)\n{\n\n}", "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", @@ -978,7 +1115,9 @@ }, { "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" : "", @@ -996,7 +1135,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1014,7 +1155,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1032,7 +1175,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1050,7 +1195,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1068,7 +1215,9 @@ }, { "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" : "", @@ -1086,7 +1235,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1104,7 +1255,9 @@ }, { "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" : "", @@ -1122,7 +1275,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1140,7 +1295,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.grid.GridView.json b/docs/symbols/Roo.grid.GridView.json index 550944374c..2b91d254d9 100644 --- a/docs/symbols/Roo.grid.GridView.json +++ b/docs/symbols/Roo.grid.GridView.json @@ -21,27 +21,33 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" } ], "methods" : [ { "name" : "getFooterPanel", + "type" : "function", "desc" : "Gets a panel in the footer of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size.", + "sig" : "(doShow)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.GridView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "doShow", @@ -60,15 +66,20 @@ }, { "name" : "fitColumns", + "type" : "function", "desc" : "Autofits all columns to the grid's width proportionate with their current size", + "sig" : "(reserveScrollSpace)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.GridView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "reserveScrollSpace", @@ -81,15 +92,20 @@ }, { "name" : "focusRow", + "type" : "function", "desc" : "Focuses the specified row.", + "sig" : "(row)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.GridView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "row", @@ -102,15 +118,20 @@ }, { "name" : "focusCell", + "type" : "function", "desc" : "Focuses the specified cell.", + "sig" : "(row, col, hscroll)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.GridView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "row", @@ -135,15 +156,20 @@ }, { "name" : "autoSizeColumn", + "type" : "function", "desc" : "Autofit a column to its content.", + "sig" : "(colIndex, forceMinSize)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.GridView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "colIndex", @@ -162,15 +188,20 @@ }, { "name" : "getHeaderPanel", + "type" : "function", "desc" : "Gets a panel in the header of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size.", + "sig" : "(doShow)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.GridView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "doShow", @@ -189,29 +220,39 @@ }, { "name" : "scrollToTop", + "type" : "function", "desc" : "Scrolls the grid to the top", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.GridView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getCell", + "type" : "function", "desc" : "Gets the 'td' of the cell", + "sig" : "(rowIndex, colIndex)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.GridView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "rowIndex", @@ -236,15 +277,20 @@ }, { "name" : "refresh", + "type" : "function", "desc" : "Refreshes the grid", + "sig" : "(headersToo)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.GridView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "headersToo", @@ -257,29 +303,39 @@ }, { "name" : "autoSizeColumns", + "type" : "function", "desc" : "Autofits all columns to their content and then expands to fit any extra space in the grid", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.GridView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "ensureVisible", + "type" : "function", "desc" : "Scrolls the specified cell into view", + "sig" : "(row, col, hscroll)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.GridView", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "row", @@ -304,29 +360,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -357,15 +423,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -390,15 +461,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -411,15 +487,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -432,15 +513,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -465,15 +551,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -498,15 +589,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -525,15 +621,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -558,15 +659,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", diff --git a/docs/symbols/Roo.grid.PropertyGrid.json b/docs/symbols/Roo.grid.PropertyGrid.json index 79c84bee48..22831882a2 100644 --- a/docs/symbols/Roo.grid.PropertyGrid.json +++ b/docs/symbols/Roo.grid.PropertyGrid.json @@ -29,223 +29,225 @@ } ], "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", - "optvals" : [] + "name" : "trackMouseOver", + "type" : "Boolean", + "desc" : "True to highlight rows when the mouse is over. Default is true.", + "memberOf" : "Roo.grid.Grid" }, { - "name" : "autoSizeColumns", - "type" : "Boolean", - "desc" : "True to automatically resize the columns to fit their content\non initial render. It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "name" : "ddText", + "type" : "String", + "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.", + "memberOf" : "Roo.grid.Grid" }, { - "name" : "customEditors", + "name" : "propertyNames", "type" : "Object", - "desc" : "map of colnames=> custom editors.\nthe custom editor can be one of the standard ones (date|string|number|int|boolean), or a\ngrid editor eg. Roo.grid.GridEditor(new Roo.form.TextArea({selectOnFocus:true})),\nfalse disables editing of the field.", - "memberOf" : "Roo.grid.PropertyGrid", - "optvals" : [] + "desc" : "map of property Names to their displayed value", + "memberOf" : "" }, { - "name" : "maxRowsToMeasure", - "type" : "Boolean", - "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "name" : "autoExpandMax", + "type" : "Number", + "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.", + "memberOf" : "Roo.grid.Grid" }, { - "name" : "minColumnWidth", - "type" : "Number", - "desc" : "The minimum width a column can be resized to. Default is 25.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "name" : "cm[]", + "type" : "Roo.grid.ColumnModel", + "desc" : "The columns of the grid", + "memberOf" : "Roo.grid.Grid" }, { - "name" : "ddText", - "type" : "String", - "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "name" : "view", + "type" : "Roo.grid.GridView", + "desc" : "The view that renders the grid (default = Roo.grid.GridView)", + "memberOf" : "Roo.grid.Grid" }, { - "name" : "autoExpandColumn", - "type" : "String", - "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "name" : "stripeRows", + "type" : "Boolean", + "desc" : "True to stripe the rows. Default is true.", + "memberOf" : "Roo.grid.Grid" }, { - "name" : "autoExpandMax", + "name" : "minColumnWidth", "type" : "Number", - "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "desc" : "The minimum width a column can be resized to. Default is 25.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "monitorWindowResize", + "type" : "Boolean", + "desc" : "True to autoSize the grid when the window resizes. Default is true.", + "memberOf" : "Roo.grid.Grid" }, { "name" : "enableRowHeightSync", "type" : "Boolean", "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" }, { - "name" : "propertyNames", - "type" : "Object", - "desc" : "map of property Names to their displayed value", - "memberOf" : "Roo.grid.PropertyGrid", - "optvals" : [] + "name" : "ds", + "type" : "Roo.grid.Store", + "desc" : "The data store for the grid", + "memberOf" : "Roo.grid.Grid" }, { - "name" : "enableDrop", + "name" : "autoSizeHeaders", "type" : "Boolean", - "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "desc" : "True to measure headers with column data when auto sizing columns. Default is true.", + "memberOf" : "Roo.grid.Grid" }, { - "name" : "monitorWindowResize", - "type" : "Boolean", - "desc" : "True to autoSize the grid when the window resizes. Default is true.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "name" : "toolbar", + "type" : "Roo.Toolbar", + "desc" : "a toolbar for buttons etc.", + "memberOf" : "Roo.grid.Grid" }, { - "name" : "autoExpandMin", - "type" : "Number", - "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "name" : "sm", + "type" : "Roo.grid.AbstractSelectionModel", + "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)", + "memberOf" : "Roo.grid.Grid" }, { - "name" : "view", + "name" : "listeners", "type" : "Object", - "desc" : "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "desc" : "list of events and 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" : "enableDrag", + "name" : "enableColumnHide", "type" : "Boolean", - "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "desc" : "True to enable hiding of columns with the header context menu. Default is true.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "enableColumnMove", + "type" : "Boolean", + "desc" : "True to enable drag and drop reorder of columns. Default is true.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "dragGroup", + "type" : "String", + "desc" : "- drag group (?? not sure if needed.)", + "memberOf" : "Roo.grid.Grid" }, { "name" : "ddGroup", "type" : "String", "desc" : "- drag drop group.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" }, { - "name" : "autoWidth", + "name" : "enableDragDrop", "type" : "Boolean", - "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "desc" : "True to enable drag and drop of rows. Default is false.", + "memberOf" : "Roo.grid.Grid" }, { - "name" : "maxHeight", + "name" : "enableDrop", + "type" : "Boolean", + "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "clicksToEdit", "type" : "Number", - "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "desc" : "The number of clicks on a cell required to display the cell's editor (defaults to 2)", + "memberOf" : "Roo.grid.EditorGrid" }, { - "name" : "trackMouseOver", + "name" : "autoExpandColumn", + "type" : "String", + "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "maxRowsToMeasure", "type" : "Boolean", - "desc" : "True to highlight rows when the mouse is over. Default is true.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).", + "memberOf" : "Roo.grid.Grid" }, { "name" : "loadMask", "type" : "Object", "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" }, { - "name" : "stripeRows", - "type" : "Boolean", - "desc" : "True to stripe the rows. Default is true.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] - }, - { - "name" : "enableColumnMove", - "type" : "Boolean", - "desc" : "True to enable drag and drop reorder of columns. Default is true.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "name" : "customEditors", + "type" : "Object", + "desc" : "map of colnames=> custom editors.\nthe custom editor can be one of the standard ones (date|string|number|int|boolean), or a\ngrid editor eg. Roo.grid.GridEditor(new Roo.form.TextArea({selectOnFocus:true})),\nfalse disables editing of the field.", + "memberOf" : "" }, { - "name" : "enableColumnHide", + "name" : "autoHeight", "type" : "Boolean", - "desc" : "True to enable hiding of columns with the header context menu. Default is true.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] - }, - { - "name" : "clicksToEdit", - "type" : "Number", - "desc" : "The number of clicks on a cell required to display the cell's editor (defaults to 2)", - "memberOf" : "Roo.grid.EditorGrid", - "optvals" : [] + "desc" : "True to fit the height of the grid container to the height of the data. Default is false.", + "memberOf" : "Roo.grid.Grid" }, { - "name" : "autoSizeHeaders", + "name" : "autoSizeColumns", "type" : "Boolean", - "desc" : "True to measure headers with column data when auto sizing columns. Default is true.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "desc" : "True to automatically resize the columns to fit their content\non initial render. It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.", + "memberOf" : "Roo.grid.Grid" }, { - "name" : "enableDragDrop", + "name" : "enableDrag", "type" : "Boolean", - "desc" : "True to enable drag and drop of rows. Default is false.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)", + "memberOf" : "Roo.grid.Grid" }, { "name" : "dropTarget", "type" : "Roo.dd.DropTarget", "desc" : "An {@link Roo.dd.DropTarget} config", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "memberOf" : "Roo.grid.Grid" }, { - "name" : "dragGroup", - "type" : "String", - "desc" : "- drag group (?? not sure if needed.)", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "name" : "autoWidth", + "type" : "Boolean", + "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.", + "memberOf" : "Roo.grid.Grid" }, { - "name" : "autoHeight", - "type" : "Boolean", - "desc" : "True to fit the height of the grid container to the height of the data. Default is false.", - "memberOf" : "Roo.grid.Grid", - "optvals" : [] + "name" : "maxHeight", + "type" : "Number", + "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.", + "memberOf" : "Roo.grid.Grid" + }, + { + "name" : "autoExpandMin", + "type" : "Number", + "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.", + "memberOf" : "Roo.grid.Grid" } ], "methods" : [ { "name" : "getSource", + "type" : "function", "desc" : "Gets all the data from the grid.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.PropertyGrid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -257,15 +259,20 @@ }, { "name" : "setSource", + "type" : "function", "desc" : "Sets the data for the Grid\naccepts a Key => Value object of all the elements avaiable.", + "sig" : "(data)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.PropertyGrid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "data", @@ -278,29 +285,39 @@ }, { "name" : "stopEditing", + "type" : "function", "desc" : "Stops any active editing", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.EditorGrid", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.EditorGrid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getDragDropText", + "type" : "function", "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.EditorGrid", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.EditorGrid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -312,15 +329,20 @@ }, { "name" : "startEditing", + "type" : "function", "desc" : "Starts editing the specified for the specified row/column", + "sig" : "(rowIndex, colIndex)", + "static" : false, + "memberOf" : "Roo.grid.EditorGrid", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.EditorGrid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "rowIndex", @@ -339,15 +361,20 @@ }, { "name" : "getSelectionModel", + "type" : "function", "desc" : "Returns the grid's SelectionModel.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -359,15 +386,20 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Destroy this grid.", + "sig" : "(removeEl)", + "static" : false, + "memberOf" : "Roo.grid.Grid", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "removeEl", @@ -380,15 +412,20 @@ }, { "name" : "getColumnModel", + "type" : "function", "desc" : "Returns the grid's ColumnModel.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -400,15 +437,20 @@ }, { "name" : "getGridEl", + "type" : "function", "desc" : "Returns the grid's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -420,15 +462,20 @@ }, { "name" : "getDataSource", + "type" : "function", "desc" : "Returns the grid's DataSource.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -440,29 +487,39 @@ }, { "name" : "autoSize", + "type" : "function", "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getView", + "type" : "function", "desc" : "Returns the grid's GridView object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -474,15 +531,20 @@ }, { "name" : "reconfigure", + "type" : "function", "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.", + "sig" : "(dataSource, The)", + "static" : false, + "memberOf" : "Roo.grid.Grid", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "dataSource", @@ -501,15 +563,20 @@ }, { "name" : "addColumns", + "type" : "function", "desc" : "addColumns\nAdd's a column, default at the end..", + "sig" : "(position, of)", + "static" : false, + "memberOf" : "Roo.grid.Grid", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "position", @@ -528,15 +595,20 @@ }, { "name" : "render", + "type" : "function", "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.Grid", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -548,29 +620,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -601,15 +683,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -634,15 +721,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -655,15 +747,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -676,15 +773,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -709,15 +811,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -742,15 +849,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -769,15 +881,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -802,15 +919,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -843,8 +965,10 @@ "events" : [ { "name" : "beforepropertychange", + "type" : "function", "desc" : "Fires before a property changes (return false to stop?)", - "memberOf" : "Roo.grid.PropertyGrid", + "sig" : "function (grid, id, newval, oldval)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -879,8 +1003,10 @@ }, { "name" : "propertychange", + "type" : "function", "desc" : "Fires after a property changes", - "memberOf" : "Roo.grid.PropertyGrid", + "sig" : "function (grid, id, newval, oldval)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -915,7 +1041,9 @@ }, { "name" : "validateedit", + "type" : "function", "desc" : "Fires after a cell is edited, but before the value is set in the record. \nYou can use this to modify the value being set in the field, Return false\nto cancel the change. The edit event object has the following properties
\n
    \n
  • editor - This editor
  • \n
  • grid - This grid
  • \n
  • record - The record being edited
  • \n
  • field - The field name being edited
  • \n
  • value - The value being set
  • \n
  • originalValue - The original value for the field, before the edit.
  • \n
  • row - The grid row index
  • \n
  • column - The grid column index
  • \n
  • cancel - Set this to true to cancel the edit or return false from your handler.
  • \n
", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.grid.EditorGrid", "example" : "", "deprecated" : "", @@ -933,7 +1061,9 @@ }, { "name" : "beforeedit", + "type" : "function", "desc" : "Fires before cell editing is triggered. The edit event object has the following properties
\n
    \n
  • grid - This grid
  • \n
  • record - The record being edited
  • \n
  • field - The field name being edited
  • \n
  • value - The value for the field being edited.
  • \n
  • row - The grid row index
  • \n
  • column - The grid column index
  • \n
  • cancel - Set this to true to cancel the edit or return false from your handler.
  • \n
", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.grid.EditorGrid", "example" : "", "deprecated" : "", @@ -951,7 +1081,9 @@ }, { "name" : "afteredit", + "type" : "function", "desc" : "Fires after a cell is edited.
\n
    \n
  • grid - This grid
  • \n
  • record - The record being edited
  • \n
  • field - The field name being edited
  • \n
  • value - The value being set
  • \n
  • originalValue - The original value for the field, before the edit.
  • \n
  • row - The grid row index
  • \n
  • column - The grid column index
  • \n
", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.grid.EditorGrid", "example" : "", "deprecated" : "", @@ -969,7 +1101,9 @@ }, { "name" : "rowcontextmenu", + "type" : "function", "desc" : "Fires when a row is right clicked", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -999,7 +1133,9 @@ }, { "name" : "columnmove", + "type" : "function", "desc" : "Fires when the user moves a column", + "sig" : "function (oldIndex, newIndex)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1023,7 +1159,9 @@ }, { "name" : "headercontextmenu", + "type" : "function", "desc" : "Fires when a header is right clicked", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1053,7 +1191,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires when the grid is rendered", + "sig" : "function (grid)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1071,7 +1211,9 @@ }, { "name" : "bodyscroll", + "type" : "function", "desc" : "Fires when the body element is scrolled", + "sig" : "function (scrollLeft, scrollTop)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1095,7 +1237,9 @@ }, { "name" : "columnresize", + "type" : "function", "desc" : "Fires when the user resizes a column", + "sig" : "function (columnIndex, newSize)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1119,7 +1263,9 @@ }, { "name" : "enddrag", + "type" : "function", "desc" : "Fires when a drag operation is complete", + "sig" : "function (_self, dd, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1149,7 +1295,9 @@ }, { "name" : "mouseout", + "type" : "function", "desc" : "The raw mouseout event for the entire grid.", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1167,7 +1315,9 @@ }, { "name" : "cellclick", + "type" : "function", "desc" : "Fires when a cell is clicked", + "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1203,7 +1353,9 @@ }, { "name" : "dragover", + "type" : "function", "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1239,7 +1391,9 @@ }, { "name" : "rowclass", + "type" : "function", "desc" : "Fires when a row is rendered, so you can change add a style to it.", + "sig" : "function (gridview, rowcfg)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1263,7 +1417,9 @@ }, { "name" : "keydown", + "type" : "function", "desc" : "The raw keydown event for the entire grid.", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1281,7 +1437,9 @@ }, { "name" : "mousedown", + "type" : "function", "desc" : "The raw mousedown event for the entire grid.", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1299,7 +1457,9 @@ }, { "name" : "dragenter", + "type" : "function", "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1335,7 +1495,9 @@ }, { "name" : "dragout", + "type" : "function", "desc" : "Fires when the dragged row(s) leave another DD target while being dragged", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1371,7 +1533,9 @@ }, { "name" : "mouseup", + "type" : "function", "desc" : "The raw mouseup event for the entire grid.", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1389,7 +1553,9 @@ }, { "name" : "keypress", + "type" : "function", "desc" : "The raw keypress event for the entire grid.", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1407,7 +1573,9 @@ }, { "name" : "headerclick", + "type" : "function", "desc" : "Fires when a header is clicked", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1437,7 +1605,9 @@ }, { "name" : "mouseover", + "type" : "function", "desc" : "The raw mouseover event for the entire grid.", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1455,7 +1625,9 @@ }, { "name" : "headerdblclick", + "type" : "function", "desc" : "Fires when a header cell is double clicked", + "sig" : "function (_self, columnIndex, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1485,7 +1657,9 @@ }, { "name" : "dragdrop", + "type" : "function", "desc" : "Fires when dragged row(s) are dropped on a valid DD target", + "sig" : "function (_self, dd, targetId, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1521,7 +1695,9 @@ }, { "name" : "rowclick", + "type" : "function", "desc" : "Fires when a row is clicked", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1551,7 +1727,9 @@ }, { "name" : "click", + "type" : "function", "desc" : "The raw click event for the entire grid.", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1569,7 +1747,9 @@ }, { "name" : "rowdblclick", + "type" : "function", "desc" : "Fires when a row is double clicked", + "sig" : "function (_self, rowIndex, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1599,7 +1779,9 @@ }, { "name" : "startdrag", + "type" : "function", "desc" : "Fires when row(s) start being dragged", + "sig" : "function (_self, dd, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1629,7 +1811,9 @@ }, { "name" : "dblclick", + "type" : "function", "desc" : "The raw dblclick event for the entire grid.", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1647,7 +1831,9 @@ }, { "name" : "cellcontextmenu", + "type" : "function", "desc" : "Fires when a cell is right clicked", + "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1683,7 +1869,9 @@ }, { "name" : "contextmenu", + "type" : "function", "desc" : "The raw contextmenu event for the entire grid.", + "sig" : "function (e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", @@ -1701,7 +1889,9 @@ }, { "name" : "celldblclick", + "type" : "function", "desc" : "Fires when a cell is double clicked", + "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}", "memberOf" : "Roo.grid.Grid", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.grid.RowSelectionModel.json b/docs/symbols/Roo.grid.RowSelectionModel.json index 502fab84d2..195b867a5a 100644 --- a/docs/symbols/Roo.grid.RowSelectionModel.json +++ b/docs/symbols/Roo.grid.RowSelectionModel.json @@ -22,34 +22,39 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "singleSelect", "type" : "Boolean", "desc" : "True to allow selection of only one row at a time (defaults to false)", - "memberOf" : "Roo.grid.RowSelectionModel", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "selectRange", + "type" : "function", "desc" : "Selects a range of rows. All rows in between startRow and endRow are also selected.", + "sig" : "(startRow, endRow, keepExisting)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "startRow", @@ -74,29 +79,39 @@ }, { "name" : "selectFirstRow", + "type" : "function", "desc" : "Selects the first row in the grid.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "deselectRow", + "type" : "function", "desc" : "Deselects a row.", + "sig" : "(row)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "row", @@ -109,15 +124,20 @@ }, { "name" : "getCount", + "type" : "function", "desc" : "Gets the number of selected rows.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -129,15 +149,20 @@ }, { "name" : "isSelected", + "type" : "function", "desc" : "Returns True if the specified row is selected.", + "sig" : "(record)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "record", @@ -156,15 +181,20 @@ }, { "name" : "selectLastRow", + "type" : "function", "desc" : "Select the last row.", + "sig" : "(keepExisting)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "keepExisting", @@ -177,15 +207,20 @@ }, { "name" : "hasSelection", + "type" : "function", "desc" : "Returns True if there is a selection.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -197,15 +232,20 @@ }, { "name" : "isIdSelected", + "type" : "function", "desc" : "Returns True if the specified record id is selected.", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -224,15 +264,20 @@ }, { "name" : "getSelected", + "type" : "function", "desc" : "Returns the first selected record.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -244,15 +289,20 @@ }, { "name" : "selectRecords", + "type" : "function", "desc" : "Select records.", + "sig" : "(records, keepExisting)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "records", @@ -271,29 +321,39 @@ }, { "name" : "clearSelections", + "type" : "function", "desc" : "Clears all selections.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "deselectRange", + "type" : "function", "desc" : "Deselects a range of rows. All rows in between startRow and endRow are also deselected.", + "sig" : "(startRow, endRow)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "startRow", @@ -312,15 +372,20 @@ }, { "name" : "getSelections", + "type" : "function", "desc" : "Returns the selected records", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -332,15 +397,20 @@ }, { "name" : "selectNext", + "type" : "function", "desc" : "Selects the row immediately following the last selected row.", + "sig" : "(keepExisting)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "keepExisting", @@ -353,29 +423,39 @@ }, { "name" : "selectAll", + "type" : "function", "desc" : "Selects all rows.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "selectRow", + "type" : "function", "desc" : "Selects a row.", + "sig" : "(row, keepExisting)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "row", @@ -394,15 +474,20 @@ }, { "name" : "selectRows", + "type" : "function", "desc" : "Selects multiple rows.", + "sig" : "(rows, keepExisting)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "rows", @@ -421,15 +506,20 @@ }, { "name" : "selectPrevious", + "type" : "function", "desc" : "Selects the row that precedes the last selected row.", + "sig" : "(keepExisting)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "keepExisting", @@ -442,29 +532,39 @@ }, { "name" : "lock", + "type" : "function", "desc" : "Locks the selections.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.AbstractSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isLocked", + "type" : "function", "desc" : "Returns true if the selections are locked.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.AbstractSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -476,43 +576,58 @@ }, { "name" : "unlock", + "type" : "function", "desc" : "Unlocks the selections.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.AbstractSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -543,15 +658,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -576,15 +696,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -597,15 +722,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -618,15 +748,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -651,15 +786,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -684,15 +824,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -711,15 +856,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -744,15 +894,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -785,8 +940,10 @@ "events" : [ { "name" : "selectionchange", + "type" : "function", "desc" : "Fires when the selection changes", - "memberOf" : "Roo.grid.RowSelectionModel", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -803,8 +960,10 @@ }, { "name" : "rowselect", + "type" : "function", "desc" : "Fires when a row is selected.", - "memberOf" : "Roo.grid.RowSelectionModel", + "sig" : "function (_self, rowIndex, r)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -833,8 +992,10 @@ }, { "name" : "beforerowselect", + "type" : "function", "desc" : "Fires when a row is selected being selected, return false to cancel.", - "memberOf" : "Roo.grid.RowSelectionModel", + "sig" : "function (_self, rowIndex, keepExisting)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -863,8 +1024,10 @@ }, { "name" : "afterselectionchange", + "type" : "function", "desc" : "Fires after the selection changes (eg. by key press or clicking)", - "memberOf" : "Roo.grid.RowSelectionModel", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -881,8 +1044,10 @@ }, { "name" : "rowdeselect", + "type" : "function", "desc" : "Fires when a row is deselected.", - "memberOf" : "Roo.grid.RowSelectionModel", + "sig" : "function (_self, rowIndex)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.grid.SplitDragZone.json b/docs/symbols/Roo.grid.SplitDragZone.json index c03989b6eb..95e83beee5 100644 --- a/docs/symbols/Roo.grid.SplitDragZone.json +++ b/docs/symbols/Roo.grid.SplitDragZone.json @@ -24,55 +24,71 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" } ], "methods" : [ { "name" : "initFrame", + "type" : "function", "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DDProxy", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DDProxy", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "createFrame", + "type" : "function", "desc" : "Creates the proxy element if it does not yet exist", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DDProxy", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DDProxy", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "alignElWithMouse", + "type" : "function", "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "sig" : "(el, iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -97,15 +113,20 @@ }, { "name" : "setDelta", + "type" : "function", "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)", + "sig" : "(iDeltaX, iDeltaY)", + "static" : false, + "memberOf" : "Roo.dd.DD", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iDeltaX", @@ -124,15 +145,20 @@ }, { "name" : "autoOffset", + "type" : "function", "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iPageX", @@ -151,15 +177,20 @@ }, { "name" : "setDragElPos", + "type" : "function", "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iPageX", @@ -178,15 +209,20 @@ }, { "name" : "cachePosition", + "type" : "function", "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.", + "sig" : "(iPageX, iPageY)", + "static" : false, + "memberOf" : "Roo.dd.DD", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DD", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iPageX", @@ -205,15 +241,20 @@ }, { "name" : "setHandleElId", + "type" : "function", "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -226,15 +267,20 @@ }, { "name" : "init", + "type" : "function", "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -259,15 +305,20 @@ }, { "name" : "removeInvalidHandleType", + "type" : "function", "desc" : "Unsets an excluded tag name set by addInvalidHandleType", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "tagName", @@ -280,29 +331,39 @@ }, { "name" : "unreg", + "type" : "function", "desc" : "Remove all drag and drop hooks for this element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "addInvalidHandleType", + "type" : "function", "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", + "sig" : "(tagName)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "tagName", @@ -315,15 +376,20 @@ }, { "name" : "onDragDrop", + "type" : "function", "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -342,15 +408,20 @@ }, { "name" : "removeInvalidHandleId", + "type" : "function", "desc" : "Unsets an invalid handle id", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -363,29 +434,39 @@ }, { "name" : "onAvailable", + "type" : "function", "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setOuterHandleElId", + "type" : "function", "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -398,15 +479,20 @@ }, { "name" : "onMouseUp", + "type" : "function", "desc" : "Event handler that fires when a drag/drop obj gets a mouseup", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -419,15 +505,20 @@ }, { "name" : "getDragEl", + "type" : "function", "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -439,15 +530,20 @@ }, { "name" : "setYConstraint", + "type" : "function", "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", + "sig" : "(iUp, iDown, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iUp", @@ -472,29 +568,39 @@ }, { "name" : "clearConstraints", + "type" : "function", "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onInvalidDrop", + "type" : "function", "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -507,15 +613,20 @@ }, { "name" : "addInvalidHandleId", + "type" : "function", "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -528,15 +639,20 @@ }, { "name" : "removeInvalidHandleClass", + "type" : "function", "desc" : "Unsets an invalid css class", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cssClass", @@ -549,15 +665,20 @@ }, { "name" : "onDragOut", + "type" : "function", "desc" : "Abstract method called when we are no longer hovering over an element", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -576,15 +697,20 @@ }, { "name" : "setDragElId", + "type" : "function", "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -597,15 +723,20 @@ }, { "name" : "endDrag", + "type" : "function", "desc" : "Fired when we are done dragging the object", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -618,15 +749,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns a reference to the linked element", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -638,15 +774,20 @@ }, { "name" : "onDrag", + "type" : "function", "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -659,15 +800,20 @@ }, { "name" : "onDragEnter", + "type" : "function", "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -686,29 +832,39 @@ }, { "name" : "lock", + "type" : "function", "desc" : "Lock this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "onMouseDown", + "type" : "function", "desc" : "Event handler that fires when a drag/drop obj gets a mousedown", + "sig" : "(e)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -721,57 +877,77 @@ }, { "name" : "applyConfig", + "type" : "function", "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "unlock", + "type" : "function", "desc" : "Unlock this instace", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isTarget", + "type" : "function", "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setInitPosition", + "type" : "function", "desc" : "Stores the initial placement of the linked element.", + "sig" : "(diffX, diffY)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "diffX", @@ -790,15 +966,20 @@ }, { "name" : "initTarget", + "type" : "function", "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", + "sig" : "(id, sGroup, config)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -823,15 +1004,20 @@ }, { "name" : "addToGroup", + "type" : "function", "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sGroup", @@ -844,15 +1030,20 @@ }, { "name" : "onDragOver", + "type" : "function", "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj", + "sig" : "(e, id)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "e", @@ -871,15 +1062,20 @@ }, { "name" : "toString", + "type" : "function", "desc" : "toString method", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -891,15 +1087,20 @@ }, { "name" : "setPadding", + "type" : "function", "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", + "sig" : "(iTop, iRight, iBot, iLeft)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iTop", @@ -930,15 +1131,20 @@ }, { "name" : "removeFromGroup", + "type" : "function", "desc" : "Remove's this instance from the supplied interaction group", + "sig" : "(sGroup)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "sGroup", @@ -951,15 +1157,20 @@ }, { "name" : "addInvalidHandleClass", + "type" : "function", "desc" : "Lets you specify a css class of elements that will not initiate a drag", + "sig" : "(cssClass)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cssClass", @@ -972,15 +1183,20 @@ }, { "name" : "startDrag", + "type" : "function", "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", + "sig" : "(X, Y)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "X", @@ -999,29 +1215,39 @@ }, { "name" : "padding", + "type" : "function", "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "resetConstraints", + "type" : "function", "desc" : "resetConstraints must be called if you manually reposition a dd element.", + "sig" : "(maintainOffset)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "maintainOffset", @@ -1034,29 +1260,39 @@ }, { "name" : "clearTicks", + "type" : "function", "desc" : "Clears any tick interval defined for this instance", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isLocked", + "type" : "function", "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -1068,15 +1304,20 @@ }, { "name" : "setXConstraint", + "type" : "function", "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.", + "sig" : "(iLeft, iRight, iTickSize)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "iLeft", @@ -1101,15 +1342,20 @@ }, { "name" : "isValidHandleChild", + "type" : "function", "desc" : "Checks the tag exclusion list to see if this click should be ignored", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.dd.DragDrop", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.dd.DragDrop", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -1128,29 +1374,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1181,15 +1437,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1214,15 +1475,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1235,15 +1501,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1256,15 +1527,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1289,15 +1565,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1322,15 +1603,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1349,15 +1635,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1382,15 +1673,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", diff --git a/docs/symbols/Roo.grid.json b/docs/symbols/Roo.grid.json index 2dde651569..952cc7c552 100644 --- a/docs/symbols/Roo.grid.json +++ b/docs/symbols/Roo.grid.json @@ -12,6 +12,8 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.json b/docs/symbols/Roo.json index cc417a48e2..ad77d208d4 100644 --- a/docs/symbols/Roo.json +++ b/docs/symbols/Roo.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "each", + "type" : "function", "desc" : "Iterates an array calling the passed function with each item, stopping if your function returns false. If the\npassed array is not really an array, your function is called once with it.\nThe supplied function is called with (Object item, Number index, Array allItems).", + "sig" : "(array, fn, scope)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "array", @@ -49,15 +56,20 @@ }, { "name" : "get", + "type" : "function", "desc" : "Static method to retrieve Element objects. Uses simple caching to consistently return the same object.\nAutomatically fixes if an object was recreated with the same id via AJAX or DOM.\nShorthand of {@link Roo.Element#get}", + "sig" : "(el)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -76,29 +88,39 @@ }, { "name" : "decode", + "type" : "function", "desc" : "Shorthand for {@link Roo.util.JSON#decode}", + "sig" : "()\n{\n\n}", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getDom", + "type" : "function", "desc" : "Return the dom node for the passed string (id), dom node, or Roo.Element", + "sig" : "(el)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -117,15 +139,20 @@ }, { "name" : "urlEncode", + "type" : "function", "desc" : "Takes an object and converts it to an encoded URL. e.g. Roo.urlEncode({foo: 1, bar: 2}); would return \"foo=1&bar=2\". Optionally, property values can be arrays, instead of keys and the resulting string that's returned will contain a name/value pair for each array value.", + "sig" : "(o)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -144,15 +171,20 @@ }, { "name" : "addBehaviors", + "type" : "function", "desc" : "Applies event listeners to elements by selectors when the document is ready.\nThe event name is specified with an @ suffix.\n
\nRoo.addBehaviors({\n   // add a listener for click on all anchors in element with id foo\n   '#foo a@click' : function(e, t){\n       // do something\n   },\n\n   // add the same listener to multiple selectors (separated by comma BEFORE the @)\n   '#foo a, #bar span.some-class@mouseover' : function(){\n       // do something\n   }\n});\n
", + "sig" : "(obj)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "obj", @@ -165,29 +197,39 @@ }, { "name" : "getGridSize", + "type" : "function", "desc" : "Find the current bootstrap width Grid size\nNote xs is the default for smaller.. - this is currently used by grids to render correct columns", + "sig" : "()\n{\n\n}", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "factory", + "type" : "function", "desc" : "Creates namespaces to be used for scoping variables and classes so that they are not global. Usage:\n
\nRoo.factory({ xns: Roo.data, xtype : 'Store', .....});\nRoo.factory(conf, Roo.data);\n
", + "sig" : "(classname, namespace)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "classname", @@ -206,15 +248,20 @@ }, { "name" : "apply", + "type" : "function", "desc" : "Copies all the properties of config to obj.", + "sig" : "(obj, config, defaults)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "obj", @@ -245,15 +292,20 @@ }, { "name" : "onReady", + "type" : "function", "desc" : "Fires when the document is ready (before onload and before images are loaded). Shorthand of {@link Roo.EventManager#onDocumentReady}.", + "sig" : "(fn, scope, override)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -278,15 +330,20 @@ }, { "name" : "select", + "type" : "function", "desc" : "Selects elements based on the passed CSS selector to enable working on them as 1.", + "sig" : "(selector, unique, root)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -317,15 +374,20 @@ }, { "name" : "applyIf", + "type" : "function", "desc" : "Copies all the properties of config to obj if they don't already exist.", + "sig" : "(obj, config)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "obj", @@ -350,15 +412,20 @@ }, { "name" : "getCmp", + "type" : "function", "desc" : "Shorthand for {@link Roo.ComponentMgr#get}", + "sig" : "(id)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -377,15 +444,20 @@ }, { "name" : "id", + "type" : "function", "desc" : "Generates unique ids. If the element already has an id, it is unchanged", + "sig" : "(el, prefix)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -410,15 +482,20 @@ }, { "name" : "encodeURIComponent", + "type" : "function", "desc" : "Safe version of encodeURIComponent", + "sig" : "(data)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "data", @@ -437,29 +514,39 @@ }, { "name" : "encode", + "type" : "function", "desc" : "Shorthand for {@link Roo.util.JSON#encode}", + "sig" : "()\n{\n\n}", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "fly", + "type" : "function", "desc" : "Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -\nthe dom node can be overwritten by other code.\nShorthand of {@link Roo.Element#fly}", + "sig" : "(el, named)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -484,15 +571,20 @@ }, { "name" : "isEmpty", + "type" : "function", "desc" : "Returns true if the passed value is null, undefined or an empty string (optional).", + "sig" : "(value, allowBlank)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -517,15 +609,20 @@ }, { "name" : "query", + "type" : "function", "desc" : "Selects an array of DOM nodes by CSS/XPath selector. Shorthand of {@link Roo.DomQuery#select}", + "sig" : "(path, root)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "path", @@ -550,15 +647,20 @@ }, { "name" : "urlDecode", + "type" : "function", "desc" : "Takes an encoded URL and and converts it to an object. e.g. Roo.urlDecode(\"foo=1&bar=2\"); would return {foo: 1, bar: 2} or Roo.urlDecode(\"foo=1&bar=2&bar=3&bar=4\", true); would return {foo: 1, bar: [2, 3, 4]}.", + "sig" : "(string, overwrite)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "string", @@ -583,15 +685,20 @@ }, { "name" : "escapeRe", + "type" : "function", "desc" : "Escapes the passed string for use in a regular expression", + "sig" : "(str)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "str", @@ -610,15 +717,20 @@ }, { "name" : "extend", + "type" : "function", "desc" : "Extends one class with another class and optionally overrides members with the passed literal. This class\nalso adds the function \"override()\" to the class that can be used to override\nmembers on an instance.", + "sig" : "(subclass, superclass, overrides)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "subclass", @@ -643,15 +755,20 @@ }, { "name" : "override", + "type" : "function", "desc" : "Adds a list of functions to the prototype of an existing class, overwriting any existing methods with the same name.\nUsage:
\nRoo.override(MyClass, {\n    newMethod1: function(){\n        // etc.\n    },\n    newMethod2: function(foo){\n        // etc.\n    }\n});\n 
", + "sig" : "(origclass, overrides)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "origclass", @@ -670,15 +787,20 @@ }, { "name" : "selectNode", + "type" : "function", "desc" : "Selects a single element as a Roo Element\nThis is about as close as you can get to jQuery's $('do crazy stuff')", + "sig" : "(selector, root)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -703,15 +825,20 @@ }, { "name" : "type", + "type" : "function", "desc" : "Returns the type of object that is passed in. If the object passed in is null or undefined it\nreturn false otherwise it returns one of the following values:
    \n
  • string: If the object passed is a string
  • \n
  • number: If the object passed is a number
  • \n
  • boolean: If the object passed is a boolean value
  • \n
  • function: If the object passed is a function reference
  • \n
  • object: If the object passed is an object
  • \n
  • array: If the object passed is an array
  • \n
  • regexp: If the object passed is a regular expression
  • \n
  • element: If the object passed is a DOM Element
  • \n
  • nodelist: If the object passed is a DOM NodeList
  • \n
  • textnode: If the object passed is a DOM text node and contains something other than whitespace
  • \n
  • whitespace: If the object passed is a DOM text node and contains only whitespace
  • ", + "sig" : "(object)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", diff --git a/docs/symbols/Roo.lib.Ajax.json b/docs/symbols/Roo.lib.Ajax.json index 9738863195..2a2f51db26 100644 --- a/docs/symbols/Roo.lib.Ajax.json +++ b/docs/symbols/Roo.lib.Ajax.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "request", + "type" : "function", "desc" : "", + "sig" : "()\n{\n\n}", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.lib.Ajax", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] } diff --git a/docs/symbols/Roo.lib.Dom.json b/docs/symbols/Roo.lib.Dom.json index e08d93c01c..eddbcbef0d 100644 --- a/docs/symbols/Roo.lib.Dom.json +++ b/docs/symbols/Roo.lib.Dom.json @@ -12,6 +12,8 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.lib.json b/docs/symbols/Roo.lib.json index cdc8038c95..8ceee9868b 100644 --- a/docs/symbols/Roo.lib.json +++ b/docs/symbols/Roo.lib.json @@ -12,6 +12,8 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.menu.Adapter.json b/docs/symbols/Roo.menu.Adapter.json index 8e57700158..ff05f203c3 100644 --- a/docs/symbols/Roo.menu.Adapter.json +++ b/docs/symbols/Roo.menu.Adapter.json @@ -23,100 +23,93 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "hidden", "type" : "Boolean", "desc" : "True to prevent creation of this menu item (defaults to false)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "activeClass", "type" : "String", "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "handler", "type" : "Function", "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "hideDelay", "type" : "Number", "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "hideOnClick", "type" : "Boolean", "desc" : "True to hide the containing menu after this item is clicked (defaults to true)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "canActivate", "type" : "Boolean", "desc" : "True if this item can be visually activated (defaults to false)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -128,15 +121,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -149,43 +147,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -198,15 +211,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -218,15 +236,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -245,15 +268,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -265,15 +293,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -285,15 +318,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -312,15 +350,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -332,15 +375,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -352,29 +400,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -405,15 +463,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -438,15 +501,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -459,15 +527,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -480,15 +553,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -513,15 +591,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -546,15 +629,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -573,15 +661,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -606,15 +699,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -647,7 +745,9 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "Fires when this item is clicked", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.menu.BaseItem", "example" : "", "deprecated" : "", @@ -671,7 +771,9 @@ }, { "name" : "activate", + "type" : "function", "desc" : "Fires when this item is activated", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.BaseItem", "example" : "", "deprecated" : "", @@ -689,7 +791,9 @@ }, { "name" : "deactivate", + "type" : "function", "desc" : "Fires when this item is deactivated", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.BaseItem", "example" : "", "deprecated" : "", @@ -707,7 +811,9 @@ }, { "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" : "", @@ -725,7 +831,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -743,7 +851,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -761,7 +871,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -779,7 +891,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -797,7 +911,9 @@ }, { "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" : "", @@ -815,7 +931,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -833,7 +951,9 @@ }, { "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" : "", @@ -851,7 +971,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -869,7 +991,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.menu.BaseItem.json b/docs/symbols/Roo.menu.BaseItem.json index 96badcb2b8..22f6a1390c 100644 --- a/docs/symbols/Roo.menu.BaseItem.json +++ b/docs/symbols/Roo.menu.BaseItem.json @@ -22,100 +22,93 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "activeClass", "type" : "String", "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "hidden", "type" : "Boolean", "desc" : "True to prevent creation of this menu item (defaults to false)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "handler", "type" : "Function", "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "hideDelay", "type" : "Number", "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "hideOnClick", "type" : "Boolean", "desc" : "True to hide the containing menu after this item is clicked (defaults to true)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "canActivate", "type" : "Boolean", "desc" : "True if this item can be visually activated (defaults to false)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -127,15 +120,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -148,43 +146,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -197,15 +210,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -217,15 +235,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -244,15 +267,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -264,15 +292,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -284,15 +317,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -311,15 +349,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -331,15 +374,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -351,29 +399,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -404,15 +462,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -437,15 +500,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -458,15 +526,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -479,15 +552,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -512,15 +590,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -545,15 +628,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -572,15 +660,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -605,15 +698,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -646,8 +744,10 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "Fires when this item is clicked", - "memberOf" : "Roo.menu.BaseItem", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -670,8 +770,10 @@ }, { "name" : "activate", + "type" : "function", "desc" : "Fires when this item is activated", - "memberOf" : "Roo.menu.BaseItem", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -688,8 +790,10 @@ }, { "name" : "deactivate", + "type" : "function", "desc" : "Fires when this item is deactivated", - "memberOf" : "Roo.menu.BaseItem", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -706,7 +810,9 @@ }, { "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" : "", @@ -724,7 +830,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -742,7 +850,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -760,7 +870,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -778,7 +890,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -796,7 +910,9 @@ }, { "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" : "", @@ -814,7 +930,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -832,7 +950,9 @@ }, { "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" : "", @@ -850,7 +970,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -868,7 +990,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.menu.CheckItem.json b/docs/symbols/Roo.menu.CheckItem.json index 644f5fc5e4..472dc08de9 100644 --- a/docs/symbols/Roo.menu.CheckItem.json +++ b/docs/symbols/Roo.menu.CheckItem.json @@ -24,156 +24,147 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "showDelay", "type" : "Number", "desc" : "Length of time in milliseconds to wait before showing this item (defaults to 200)", - "memberOf" : "Roo.menu.Item", - "optvals" : [] + "memberOf" : "Roo.menu.Item" }, { "name" : "text", "type" : "String", "desc" : "The text to show on the menu item.", - "memberOf" : "Roo.menu.Item", - "optvals" : [] + "memberOf" : "Roo.menu.Item" + }, + { + "name" : "menu", + "type" : "Roo.menu.Menu", + "desc" : "A Sub menu", + "memberOf" : "Roo.menu.Item" }, { "name" : "activeClass", "type" : "String", "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "hidden", "type" : "Boolean", "desc" : "True to prevent creation of this menu item (defaults to false)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "group", "type" : "String", "desc" : "All check items with the same group name will automatically be grouped into a single-select\nradio button group (defaults to '')", - "memberOf" : "Roo.menu.CheckItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "handler", "type" : "Function", "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "hideDelay", "type" : "Number", "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "hideOnClick", "type" : "Boolean", "desc" : "True to hide the containing menu after this item is clicked (defaults to true)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "itemCls", "type" : "String", "desc" : "The default CSS class to use for check items (defaults to \"x-menu-item x-menu-check-item\")", - "memberOf" : "Roo.menu.CheckItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "HTML", "type" : "String", "desc" : "to render in menu\nThe text to show on the menu item (HTML version).", - "memberOf" : "Roo.menu.Item", - "optvals" : [] + "memberOf" : "Roo.menu.Item" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "groupClass", "type" : "String", "desc" : "The default CSS class to use for radio group check items (defaults to \"x-menu-group-item\")", - "memberOf" : "Roo.menu.CheckItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "canActivate", "type" : "Boolean", "desc" : "True if this item can be visually activated (defaults to true)", - "memberOf" : "Roo.menu.Item", - "optvals" : [] + "memberOf" : "Roo.menu.Item" }, { "name" : "icon", "type" : "String", "desc" : "The path to an icon to display in this menu item (defaults to Roo.BLANK_IMAGE_URL)", - "memberOf" : "Roo.menu.Item", - "optvals" : [] + "memberOf" : "Roo.menu.Item" }, { "name" : "checked", "type" : "Boolean", "desc" : "True to initialize this checkbox as checked (defaults to false). Note that\nif this checkbox is part of a radio group (group = true) only the last item in the group that is\ninitialized with checked = true will be rendered as checked.", - "memberOf" : "Roo.menu.CheckItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "setChecked", + "type" : "function", "desc" : "Set the checked state of this item", + "sig" : "(checked, suppressEvent)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.CheckItem", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "checked", @@ -192,15 +183,20 @@ }, { "name" : "setText", + "type" : "function", "desc" : "Sets the text to display in this menu item", + "sig" : "(text, isHTML)", + "static" : false, + "memberOf" : "Roo.menu.Item", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "text", @@ -219,15 +215,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -239,15 +240,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -260,43 +266,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -309,15 +330,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -329,15 +355,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -356,15 +387,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -376,15 +412,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -396,15 +437,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -423,15 +469,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -443,15 +494,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -463,29 +519,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -516,15 +582,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -549,15 +620,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -570,15 +646,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -591,15 +672,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -624,15 +710,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -657,15 +748,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -684,15 +780,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -717,15 +818,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -758,8 +864,10 @@ "events" : [ { "name" : "beforecheckchange", + "type" : "function", "desc" : "Fires before the checked value is set, providing an opportunity to cancel if needed", - "memberOf" : "Roo.menu.CheckItem", + "sig" : "function (_self, checked)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -782,8 +890,10 @@ }, { "name" : "checkchange", + "type" : "function", "desc" : "Fires after the checked value has been set", - "memberOf" : "Roo.menu.CheckItem", + "sig" : "function (_self, checked)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -806,7 +916,9 @@ }, { "name" : "click", + "type" : "function", "desc" : "Fires when this item is clicked", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.menu.BaseItem", "example" : "", "deprecated" : "", @@ -830,7 +942,9 @@ }, { "name" : "activate", + "type" : "function", "desc" : "Fires when this item is activated", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.BaseItem", "example" : "", "deprecated" : "", @@ -848,7 +962,9 @@ }, { "name" : "deactivate", + "type" : "function", "desc" : "Fires when this item is deactivated", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.BaseItem", "example" : "", "deprecated" : "", @@ -866,7 +982,9 @@ }, { "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" : "", @@ -884,7 +1002,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -902,7 +1022,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -920,7 +1042,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -938,7 +1062,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -956,7 +1082,9 @@ }, { "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" : "", @@ -974,7 +1102,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -992,7 +1122,9 @@ }, { "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" : "", @@ -1010,7 +1142,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1028,7 +1162,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.menu.ColorItem.json b/docs/symbols/Roo.menu.ColorItem.json index 43bc84b688..3139c89804 100644 --- a/docs/symbols/Roo.menu.ColorItem.json +++ b/docs/symbols/Roo.menu.ColorItem.json @@ -24,100 +24,93 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "activeClass", "type" : "String", "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "hidden", "type" : "Boolean", "desc" : "True to prevent creation of this menu item (defaults to false)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "handler", "type" : "Function", "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "hideDelay", "type" : "Number", "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "hideOnClick", "type" : "Boolean", "desc" : "True to hide the containing menu after this item is clicked (defaults to true)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "canActivate", "type" : "Boolean", "desc" : "True if this item can be visually activated (defaults to false)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -129,15 +122,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -150,43 +148,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -199,15 +212,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -219,15 +237,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -246,15 +269,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -266,15 +294,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -286,15 +319,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -313,15 +351,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -333,15 +376,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -353,29 +401,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -406,15 +464,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -439,15 +502,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -460,15 +528,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -481,15 +554,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -514,15 +592,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -547,15 +630,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -574,15 +662,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -607,15 +700,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -648,7 +746,9 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "Fires when this item is clicked", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.menu.BaseItem", "example" : "", "deprecated" : "", @@ -672,7 +772,9 @@ }, { "name" : "activate", + "type" : "function", "desc" : "Fires when this item is activated", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.BaseItem", "example" : "", "deprecated" : "", @@ -690,7 +792,9 @@ }, { "name" : "deactivate", + "type" : "function", "desc" : "Fires when this item is deactivated", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.BaseItem", "example" : "", "deprecated" : "", @@ -708,7 +812,9 @@ }, { "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" : "", @@ -726,7 +832,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -744,7 +852,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -762,7 +872,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -780,7 +892,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -798,7 +912,9 @@ }, { "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" : "", @@ -816,7 +932,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -834,7 +952,9 @@ }, { "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" : "", @@ -852,7 +972,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -870,7 +992,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.menu.ColorMenu.json b/docs/symbols/Roo.menu.ColorMenu.json index 4cfd8aed8a..9285c147cc 100644 --- a/docs/symbols/Roo.menu.ColorMenu.json +++ b/docs/symbols/Roo.menu.ColorMenu.json @@ -22,69 +22,69 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "shadow", "type" : "Boolean/String", "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "Roo.menu.Menu" }, { "name" : "subMenuAlign", "type" : "String", "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "Roo.menu.Menu" }, { "name" : "defaultAlign", "type" : "String", "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "Roo.menu.Menu" }, { "name" : "minWidth", "type" : "Number", "desc" : "The minimum width of the menu in pixels (defaults to 120)", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "Roo.menu.Menu" }, { "name" : "registerMenu", "type" : "Boolean", "desc" : "True (default) - means that clicking on screen etc. hides it.", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "Roo.menu.Menu" }, { "name" : "allowOtherMenus", "type" : "Boolean", "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "Roo.menu.Menu" } ], "methods" : [ { "name" : "addMenuItem", + "type" : "function", "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu", + "sig" : "(config)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -103,15 +103,20 @@ }, { "name" : "addElement", + "type" : "function", "desc" : "Adds an {@link Roo.Element} object to the menu", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -130,29 +135,39 @@ }, { "name" : "isVisible", + "type" : "function", "desc" : "Read-only. Returns true if the menu is currently displayed, else false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "add", + "type" : "function", "desc" : "Addds one or more items of any type supported by the Menu class, or that can be converted into menu items.\nAny of the following are valid:\n
      \n
    • Any menu item object based on {@link Roo.menu.Item}
    • \n
    • An HTMLElement object which will be converted to a menu item
    • \n
    • A menu item config object that will be created as a new menu item
    • \n
    • A string, which can either be '-' or 'separator' to add a menu separator, otherwise\nit will be converted into a {@link Roo.menu.TextItem} and added
    • \n
    \nUsage:\n
    \n// Create the menu\nvar menu = new Roo.menu.Menu();\n\n// Create a menu item to add by reference\nvar menuItem = new Roo.menu.Item({ text: 'New Item!' });\n\n// Add a bunch of items at once using different methods.\n// Only the last item added will be returned.\nvar item = menu.add(\n    menuItem,                // add existing item by ref\n    'Dynamic Item',          // new TextItem\n    '-',                     // new separator\n    { text: 'Config Item' }  // new item by config\n);\n
    ", + "sig" : "(args)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "args", @@ -171,15 +186,20 @@ }, { "name" : "addSeparator", + "type" : "function", "desc" : "Adds a separator bar to the menu", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -191,29 +211,39 @@ }, { "name" : "removeAll", + "type" : "function", "desc" : "Removes and destroys all items in the menu", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "remove", + "type" : "function", "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object", + "sig" : "(item)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "item", @@ -226,15 +256,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns this menu's underlying {@link Roo.Element} object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -246,15 +281,20 @@ }, { "name" : "insert", + "type" : "function", "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index", + "sig" : "(index, item)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -279,15 +319,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hides this menu and optionally all parent menus", + "sig" : "(deep)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "deep", @@ -300,15 +345,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Displays this menu relative to another element", + "sig" : "(element, position, parentMenu)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "element", @@ -333,15 +383,20 @@ }, { "name" : "addText", + "type" : "function", "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu", + "sig" : "(text)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "text", @@ -360,15 +415,20 @@ }, { "name" : "addItem", + "type" : "function", "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu", + "sig" : "(item)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "item", @@ -387,15 +447,20 @@ }, { "name" : "showAt", + "type" : "function", "desc" : "Displays this menu at a specific xy position", + "sig" : "(xyPosition, parentMenu)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "xyPosition", @@ -414,29 +479,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -467,15 +542,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -500,15 +580,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -521,15 +606,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -542,15 +632,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -575,15 +670,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -608,15 +708,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -635,15 +740,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -668,15 +778,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -709,8 +824,10 @@ "events" : [ { "name" : "select", + "type" : "function", "desc" : "", - "memberOf" : "Roo.menu.ColorMenu", + "sig" : "function (palette, color)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -733,7 +850,9 @@ }, { "name" : "mouseover", + "type" : "function", "desc" : "Fires when the mouse is hovering over this menu", + "sig" : "function (_self, e, menuItem)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", @@ -763,7 +882,9 @@ }, { "name" : "mouseout", + "type" : "function", "desc" : "Fires when the mouse exits this menu", + "sig" : "function (_self, e, menuItem)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", @@ -793,7 +914,9 @@ }, { "name" : "beforehide", + "type" : "function", "desc" : "Fires before this menu is hidden", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", @@ -811,7 +934,9 @@ }, { "name" : "itemclick", + "type" : "function", "desc" : "Fires when a menu item contained in this menu is clicked", + "sig" : "function (baseItem, e)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", @@ -835,7 +960,9 @@ }, { "name" : "beforeshow", + "type" : "function", "desc" : "Fires before this menu is displayed", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", @@ -853,7 +980,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after this menu is hidden", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", @@ -871,7 +1000,9 @@ }, { "name" : "click", + "type" : "function", "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)", + "sig" : "function (_self, menuItem, e)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", @@ -901,7 +1032,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after this menu is displayed", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.menu.DateItem.json b/docs/symbols/Roo.menu.DateItem.json index c1409b51de..efd6de2677 100644 --- a/docs/symbols/Roo.menu.DateItem.json +++ b/docs/symbols/Roo.menu.DateItem.json @@ -24,100 +24,93 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "activeClass", "type" : "String", "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "hidden", "type" : "Boolean", "desc" : "True to prevent creation of this menu item (defaults to false)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "handler", "type" : "Function", "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "hideDelay", "type" : "Number", "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "hideOnClick", "type" : "Boolean", "desc" : "True to hide the containing menu after this item is clicked (defaults to true)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "canActivate", "type" : "Boolean", "desc" : "True if this item can be visually activated (defaults to false)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -129,15 +122,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -150,43 +148,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -199,15 +212,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -219,15 +237,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -246,15 +269,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -266,15 +294,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -286,15 +319,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -313,15 +351,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -333,15 +376,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -353,29 +401,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -406,15 +464,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -439,15 +502,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -460,15 +528,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -481,15 +554,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -514,15 +592,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -547,15 +630,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -574,15 +662,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -607,15 +700,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -648,7 +746,9 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "Fires when this item is clicked", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.menu.BaseItem", "example" : "", "deprecated" : "", @@ -672,7 +772,9 @@ }, { "name" : "activate", + "type" : "function", "desc" : "Fires when this item is activated", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.BaseItem", "example" : "", "deprecated" : "", @@ -690,7 +792,9 @@ }, { "name" : "deactivate", + "type" : "function", "desc" : "Fires when this item is deactivated", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.BaseItem", "example" : "", "deprecated" : "", @@ -708,7 +812,9 @@ }, { "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" : "", @@ -726,7 +832,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -744,7 +852,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -762,7 +872,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -780,7 +892,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -798,7 +912,9 @@ }, { "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" : "", @@ -816,7 +932,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -834,7 +952,9 @@ }, { "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" : "", @@ -852,7 +972,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -870,7 +992,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.menu.DateMenu.json b/docs/symbols/Roo.menu.DateMenu.json index c6c7cb1611..9868a54501 100644 --- a/docs/symbols/Roo.menu.DateMenu.json +++ b/docs/symbols/Roo.menu.DateMenu.json @@ -22,69 +22,69 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "shadow", "type" : "Boolean/String", "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "Roo.menu.Menu" }, { "name" : "defaultAlign", "type" : "String", "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "Roo.menu.Menu" }, { "name" : "subMenuAlign", "type" : "String", "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "Roo.menu.Menu" }, { "name" : "minWidth", "type" : "Number", "desc" : "The minimum width of the menu in pixels (defaults to 120)", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "Roo.menu.Menu" }, { "name" : "registerMenu", "type" : "Boolean", "desc" : "True (default) - means that clicking on screen etc. hides it.", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "Roo.menu.Menu" }, { "name" : "allowOtherMenus", "type" : "Boolean", "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "Roo.menu.Menu" } ], "methods" : [ { "name" : "addMenuItem", + "type" : "function", "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu", + "sig" : "(config)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -103,15 +103,20 @@ }, { "name" : "addElement", + "type" : "function", "desc" : "Adds an {@link Roo.Element} object to the menu", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -130,29 +135,39 @@ }, { "name" : "isVisible", + "type" : "function", "desc" : "Read-only. Returns true if the menu is currently displayed, else false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "add", + "type" : "function", "desc" : "Addds one or more items of any type supported by the Menu class, or that can be converted into menu items.\nAny of the following are valid:\n
      \n
    • Any menu item object based on {@link Roo.menu.Item}
    • \n
    • An HTMLElement object which will be converted to a menu item
    • \n
    • A menu item config object that will be created as a new menu item
    • \n
    • A string, which can either be '-' or 'separator' to add a menu separator, otherwise\nit will be converted into a {@link Roo.menu.TextItem} and added
    • \n
    \nUsage:\n
    \n// Create the menu\nvar menu = new Roo.menu.Menu();\n\n// Create a menu item to add by reference\nvar menuItem = new Roo.menu.Item({ text: 'New Item!' });\n\n// Add a bunch of items at once using different methods.\n// Only the last item added will be returned.\nvar item = menu.add(\n    menuItem,                // add existing item by ref\n    'Dynamic Item',          // new TextItem\n    '-',                     // new separator\n    { text: 'Config Item' }  // new item by config\n);\n
    ", + "sig" : "(args)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "args", @@ -171,15 +186,20 @@ }, { "name" : "addSeparator", + "type" : "function", "desc" : "Adds a separator bar to the menu", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -191,29 +211,39 @@ }, { "name" : "removeAll", + "type" : "function", "desc" : "Removes and destroys all items in the menu", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "remove", + "type" : "function", "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object", + "sig" : "(item)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "item", @@ -226,15 +256,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns this menu's underlying {@link Roo.Element} object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -246,15 +281,20 @@ }, { "name" : "insert", + "type" : "function", "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index", + "sig" : "(index, item)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -279,15 +319,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hides this menu and optionally all parent menus", + "sig" : "(deep)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "deep", @@ -300,15 +345,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Displays this menu relative to another element", + "sig" : "(element, position, parentMenu)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "element", @@ -333,15 +383,20 @@ }, { "name" : "addText", + "type" : "function", "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu", + "sig" : "(text)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "text", @@ -360,15 +415,20 @@ }, { "name" : "addItem", + "type" : "function", "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu", + "sig" : "(item)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "item", @@ -387,15 +447,20 @@ }, { "name" : "showAt", + "type" : "function", "desc" : "Displays this menu at a specific xy position", + "sig" : "(xyPosition, parentMenu)", + "static" : false, + "memberOf" : "Roo.menu.Menu", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "xyPosition", @@ -414,29 +479,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -467,15 +542,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -500,15 +580,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -521,15 +606,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -542,15 +632,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -575,15 +670,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -608,15 +708,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -635,15 +740,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -668,15 +778,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -709,8 +824,10 @@ "events" : [ { "name" : "select", + "type" : "function", "desc" : "", - "memberOf" : "Roo.menu.DateMenu", + "sig" : "function (picker, date)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -733,7 +850,9 @@ }, { "name" : "mouseover", + "type" : "function", "desc" : "Fires when the mouse is hovering over this menu", + "sig" : "function (_self, e, menuItem)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", @@ -763,7 +882,9 @@ }, { "name" : "mouseout", + "type" : "function", "desc" : "Fires when the mouse exits this menu", + "sig" : "function (_self, e, menuItem)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", @@ -793,7 +914,9 @@ }, { "name" : "beforehide", + "type" : "function", "desc" : "Fires before this menu is hidden", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", @@ -811,7 +934,9 @@ }, { "name" : "itemclick", + "type" : "function", "desc" : "Fires when a menu item contained in this menu is clicked", + "sig" : "function (baseItem, e)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", @@ -835,7 +960,9 @@ }, { "name" : "beforeshow", + "type" : "function", "desc" : "Fires before this menu is displayed", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", @@ -853,7 +980,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after this menu is hidden", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", @@ -871,7 +1000,9 @@ }, { "name" : "click", + "type" : "function", "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)", + "sig" : "function (_self, menuItem, e)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", @@ -901,7 +1032,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after this menu is displayed", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.menu.Item.json b/docs/symbols/Roo.menu.Item.json index 2eb8eafedf..e5fa1ef0be 100644 --- a/docs/symbols/Roo.menu.Item.json +++ b/docs/symbols/Roo.menu.Item.json @@ -23,135 +23,129 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "showDelay", "type" : "Number", "desc" : "Length of time in milliseconds to wait before showing this item (defaults to 200)", - "memberOf" : "Roo.menu.Item", - "optvals" : [] + "memberOf" : "" }, { "name" : "text", "type" : "String", "desc" : "The text to show on the menu item.", - "memberOf" : "Roo.menu.Item", - "optvals" : [] + "memberOf" : "" + }, + { + "name" : "menu", + "type" : "Roo.menu.Menu", + "desc" : "A Sub menu", + "memberOf" : "" }, { "name" : "activeClass", "type" : "String", "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "hidden", "type" : "Boolean", "desc" : "True to prevent creation of this menu item (defaults to false)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "handler", "type" : "Function", "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "hideDelay", "type" : "Number", "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "hideOnClick", "type" : "Boolean", "desc" : "True to hide the containing menu after this item is clicked (defaults to true)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "itemCls", "type" : "String", "desc" : "The default CSS class to use for menu items (defaults to \"x-menu-item\")", - "memberOf" : "Roo.menu.Item", - "optvals" : [] + "memberOf" : "" }, { "name" : "HTML", "type" : "String", "desc" : "to render in menu\nThe text to show on the menu item (HTML version).", - "memberOf" : "Roo.menu.Item", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "canActivate", "type" : "Boolean", "desc" : "True if this item can be visually activated (defaults to true)", - "memberOf" : "Roo.menu.Item", - "optvals" : [] + "memberOf" : "" }, { "name" : "icon", "type" : "String", "desc" : "The path to an icon to display in this menu item (defaults to Roo.BLANK_IMAGE_URL)", - "memberOf" : "Roo.menu.Item", - "optvals" : [] + "memberOf" : "" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "name" : "setText", + "type" : "function", "desc" : "Sets the text to display in this menu item", + "sig" : "(text, isHTML)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Item", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "text", @@ -170,15 +164,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -190,15 +189,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -211,43 +215,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -260,15 +279,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -280,15 +304,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -307,15 +336,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -327,15 +361,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -347,15 +386,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -374,15 +418,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -394,15 +443,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -414,29 +468,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -467,15 +531,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -500,15 +569,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -521,15 +595,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -542,15 +621,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -575,15 +659,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -608,15 +697,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -635,15 +729,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -668,15 +767,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -709,7 +813,9 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "Fires when this item is clicked", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.menu.BaseItem", "example" : "", "deprecated" : "", @@ -733,7 +839,9 @@ }, { "name" : "activate", + "type" : "function", "desc" : "Fires when this item is activated", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.BaseItem", "example" : "", "deprecated" : "", @@ -751,7 +859,9 @@ }, { "name" : "deactivate", + "type" : "function", "desc" : "Fires when this item is deactivated", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.BaseItem", "example" : "", "deprecated" : "", @@ -769,7 +879,9 @@ }, { "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" : "", @@ -787,7 +899,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -805,7 +919,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -823,7 +939,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -841,7 +959,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -859,7 +979,9 @@ }, { "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" : "", @@ -877,7 +999,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -895,7 +1019,9 @@ }, { "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" : "", @@ -913,7 +1039,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -931,7 +1059,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.menu.Menu.json b/docs/symbols/Roo.menu.Menu.json index 522095e8d0..070aa4d673 100644 --- a/docs/symbols/Roo.menu.Menu.json +++ b/docs/symbols/Roo.menu.Menu.json @@ -21,69 +21,69 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "shadow", "type" : "Boolean/String", "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "" }, { "name" : "defaultAlign", "type" : "String", "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "" }, { "name" : "subMenuAlign", "type" : "String", "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "" }, { "name" : "minWidth", "type" : "Number", "desc" : "The minimum width of the menu in pixels (defaults to 120)", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "" }, { "name" : "registerMenu", "type" : "Boolean", "desc" : "True (default) - means that clicking on screen etc. hides it.", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowOtherMenus", "type" : "Boolean", "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)", - "memberOf" : "Roo.menu.Menu", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "addMenuItem", + "type" : "function", "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu", + "sig" : "(config)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "config", @@ -102,15 +102,20 @@ }, { "name" : "addElement", + "type" : "function", "desc" : "Adds an {@link Roo.Element} object to the menu", + "sig" : "(el)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -129,29 +134,39 @@ }, { "name" : "isVisible", + "type" : "function", "desc" : "Read-only. Returns true if the menu is currently displayed, else false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "add", + "type" : "function", "desc" : "Addds one or more items of any type supported by the Menu class, or that can be converted into menu items.\nAny of the following are valid:\n
      \n
    • Any menu item object based on {@link Roo.menu.Item}
    • \n
    • An HTMLElement object which will be converted to a menu item
    • \n
    • A menu item config object that will be created as a new menu item
    • \n
    • A string, which can either be '-' or 'separator' to add a menu separator, otherwise\nit will be converted into a {@link Roo.menu.TextItem} and added
    • \n
    \nUsage:\n
    \n// Create the menu\nvar menu = new Roo.menu.Menu();\n\n// Create a menu item to add by reference\nvar menuItem = new Roo.menu.Item({ text: 'New Item!' });\n\n// Add a bunch of items at once using different methods.\n// Only the last item added will be returned.\nvar item = menu.add(\n    menuItem,                // add existing item by ref\n    'Dynamic Item',          // new TextItem\n    '-',                     // new separator\n    { text: 'Config Item' }  // new item by config\n);\n
    ", + "sig" : "(args)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "args", @@ -170,15 +185,20 @@ }, { "name" : "addSeparator", + "type" : "function", "desc" : "Adds a separator bar to the menu", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -190,29 +210,39 @@ }, { "name" : "removeAll", + "type" : "function", "desc" : "Removes and destroys all items in the menu", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "remove", + "type" : "function", "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object", + "sig" : "(item)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "item", @@ -225,15 +255,20 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns this menu's underlying {@link Roo.Element} object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -245,15 +280,20 @@ }, { "name" : "insert", + "type" : "function", "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index", + "sig" : "(index, item)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -278,15 +318,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hides this menu and optionally all parent menus", + "sig" : "(deep)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "deep", @@ -299,15 +344,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Displays this menu relative to another element", + "sig" : "(element, position, parentMenu)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "element", @@ -332,15 +382,20 @@ }, { "name" : "addText", + "type" : "function", "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu", + "sig" : "(text)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "text", @@ -359,15 +414,20 @@ }, { "name" : "addItem", + "type" : "function", "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu", + "sig" : "(item)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "item", @@ -386,15 +446,20 @@ }, { "name" : "showAt", + "type" : "function", "desc" : "Displays this menu at a specific xy position", + "sig" : "(xyPosition, parentMenu)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.Menu", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "xyPosition", @@ -413,29 +478,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -466,15 +541,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -499,15 +579,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -520,15 +605,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -541,15 +631,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -574,15 +669,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -607,15 +707,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -634,15 +739,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -667,15 +777,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -708,8 +823,10 @@ "events" : [ { "name" : "mouseover", + "type" : "function", "desc" : "Fires when the mouse is hovering over this menu", - "memberOf" : "Roo.menu.Menu", + "sig" : "function (_self, e, menuItem)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -738,8 +855,10 @@ }, { "name" : "mouseout", + "type" : "function", "desc" : "Fires when the mouse exits this menu", - "memberOf" : "Roo.menu.Menu", + "sig" : "function (_self, e, menuItem)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -768,8 +887,10 @@ }, { "name" : "beforehide", + "type" : "function", "desc" : "Fires before this menu is hidden", - "memberOf" : "Roo.menu.Menu", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -786,8 +907,10 @@ }, { "name" : "itemclick", + "type" : "function", "desc" : "Fires when a menu item contained in this menu is clicked", - "memberOf" : "Roo.menu.Menu", + "sig" : "function (baseItem, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -810,8 +933,10 @@ }, { "name" : "beforeshow", + "type" : "function", "desc" : "Fires before this menu is displayed", - "memberOf" : "Roo.menu.Menu", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -828,8 +953,10 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after this menu is hidden", - "memberOf" : "Roo.menu.Menu", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -846,8 +973,10 @@ }, { "name" : "click", + "type" : "function", "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)", - "memberOf" : "Roo.menu.Menu", + "sig" : "function (_self, menuItem, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -876,8 +1005,10 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after this menu is displayed", - "memberOf" : "Roo.menu.Menu", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.menu.MenuMgr.json b/docs/symbols/Roo.menu.MenuMgr.json index a482e5a452..5f19f84db5 100644 --- a/docs/symbols/Roo.menu.MenuMgr.json +++ b/docs/symbols/Roo.menu.MenuMgr.json @@ -12,33 +12,45 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "hideAll", + "type" : "function", "desc" : "Hides all menus that are currently visible", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.MenuMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "get", + "type" : "function", "desc" : "Returns a {@link Roo.menu.Menu} object", + "sig" : "(menu)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.menu.MenuMgr", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "menu", diff --git a/docs/symbols/Roo.menu.Separator.json b/docs/symbols/Roo.menu.Separator.json index 903e5d3da1..6365339840 100644 --- a/docs/symbols/Roo.menu.Separator.json +++ b/docs/symbols/Roo.menu.Separator.json @@ -23,107 +23,99 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "activeClass", "type" : "String", "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "hidden", "type" : "Boolean", "desc" : "True to prevent creation of this menu item (defaults to false)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "hideOnClick", "type" : "Boolean", "desc" : "True to hide the containing menu after this item is clicked (defaults to false)", - "memberOf" : "Roo.menu.Separator", - "optvals" : [] + "memberOf" : "" }, { "name" : "handler", "type" : "Function", "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "hideDelay", "type" : "Number", "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "itemCls", "type" : "String", "desc" : "The default CSS class to use for separators (defaults to \"x-menu-sep\")", - "memberOf" : "Roo.menu.Separator", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "canActivate", "type" : "Boolean", "desc" : "True if this item can be visually activated (defaults to false)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -135,15 +127,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -156,43 +153,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -205,15 +217,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -225,15 +242,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -252,15 +274,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -272,15 +299,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -292,15 +324,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -319,15 +356,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -339,15 +381,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -359,29 +406,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -412,15 +469,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -445,15 +507,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -466,15 +533,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -487,15 +559,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -520,15 +597,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -553,15 +635,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -580,15 +667,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -613,15 +705,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -654,7 +751,9 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "Fires when this item is clicked", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.menu.BaseItem", "example" : "", "deprecated" : "", @@ -678,7 +777,9 @@ }, { "name" : "activate", + "type" : "function", "desc" : "Fires when this item is activated", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.BaseItem", "example" : "", "deprecated" : "", @@ -696,7 +797,9 @@ }, { "name" : "deactivate", + "type" : "function", "desc" : "Fires when this item is deactivated", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.BaseItem", "example" : "", "deprecated" : "", @@ -714,7 +817,9 @@ }, { "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" : "", @@ -732,7 +837,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -750,7 +857,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -768,7 +877,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -786,7 +897,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -804,7 +917,9 @@ }, { "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" : "", @@ -822,7 +937,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -840,7 +957,9 @@ }, { "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" : "", @@ -858,7 +977,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -876,7 +997,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.menu.TextItem.json b/docs/symbols/Roo.menu.TextItem.json index c3e3e15def..21db531c33 100644 --- a/docs/symbols/Roo.menu.TextItem.json +++ b/docs/symbols/Roo.menu.TextItem.json @@ -23,114 +23,105 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "text", "type" : "String", "desc" : "Text to show on item.", - "memberOf" : "Roo.menu.TextItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "activeClass", "type" : "String", "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "hidden", "type" : "Boolean", "desc" : "True to prevent creation of this menu item (defaults to false)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "hideOnClick", "type" : "Boolean", "desc" : "True to hide the containing menu after this item is clicked (defaults to false)", - "memberOf" : "Roo.menu.TextItem", - "optvals" : [] + "memberOf" : "" }, { "name" : "handler", "type" : "Function", "desc" : "A function that will handle the click event of this menu item (defaults to undefined)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "hideDelay", "type" : "Number", "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "itemCls", "type" : "String", "desc" : "The default CSS class to use for text items (defaults to \"x-menu-text\")", - "memberOf" : "Roo.menu.TextItem", - "optvals" : [] + "memberOf" : "" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "canActivate", "type" : "Boolean", "desc" : "True if this item can be visually activated (defaults to false)", - "memberOf" : "Roo.menu.BaseItem", - "optvals" : [] + "memberOf" : "Roo.menu.BaseItem" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" } ], "methods" : [ { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -142,15 +133,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -163,43 +159,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -212,15 +223,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -232,15 +248,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -259,15 +280,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -279,15 +305,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -299,15 +330,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -326,15 +362,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -346,15 +387,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -366,29 +412,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -419,15 +475,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -452,15 +513,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -473,15 +539,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -494,15 +565,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -527,15 +603,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -560,15 +641,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -587,15 +673,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -620,15 +711,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -661,7 +757,9 @@ "events" : [ { "name" : "click", + "type" : "function", "desc" : "Fires when this item is clicked", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.menu.BaseItem", "example" : "", "deprecated" : "", @@ -685,7 +783,9 @@ }, { "name" : "activate", + "type" : "function", "desc" : "Fires when this item is activated", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.BaseItem", "example" : "", "deprecated" : "", @@ -703,7 +803,9 @@ }, { "name" : "deactivate", + "type" : "function", "desc" : "Fires when this item is deactivated", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.menu.BaseItem", "example" : "", "deprecated" : "", @@ -721,7 +823,9 @@ }, { "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" : "", @@ -739,7 +843,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -757,7 +863,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -775,7 +883,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -793,7 +903,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -811,7 +923,9 @@ }, { "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" : "", @@ -829,7 +943,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -847,7 +963,9 @@ }, { "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" : "", @@ -865,7 +983,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -883,7 +1003,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.menu.json b/docs/symbols/Roo.menu.json index dfa9714972..48831652d6 100644 --- a/docs/symbols/Roo.menu.json +++ b/docs/symbols/Roo.menu.json @@ -12,6 +12,8 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.state.CookieProvider.json b/docs/symbols/Roo.state.CookieProvider.json index 4211c5b451..5d7a73032a 100644 --- a/docs/symbols/Roo.state.CookieProvider.json +++ b/docs/symbols/Roo.state.CookieProvider.json @@ -21,48 +21,51 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "path", "type" : "String", "desc" : "The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site)", - "memberOf" : "Roo.state.CookieProvider", - "optvals" : [] + "memberOf" : "" }, { "name" : "secure", "type" : "Boolean", "desc" : "True if the site is using SSL (defaults to false)", - "memberOf" : "Roo.state.CookieProvider", - "optvals" : [] + "memberOf" : "" }, { "name" : "domain", "type" : "String", "desc" : "The domain to save the cookie for. Note that you cannot specify a different domain than\nyour page is on, but you can specify a sub-domain, or simply the domain itself like 'roojs.com' to include\nall sub-domains if you need to access cookies across different sub-domains (defaults to null which uses the same\ndomain the page is running on including the 'www' like 'www.roojs.com')", - "memberOf" : "Roo.state.CookieProvider", - "optvals" : [] + "memberOf" : "" }, { "name" : "expires", "type" : "Date", "desc" : "The cookie expiration date (defaults to 7 days from now)", - "memberOf" : "Roo.state.CookieProvider", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "clear", + "type" : "function", "desc" : "Clears a value from the state", + "sig" : "(name)", + "static" : false, + "memberOf" : "Roo.state.Provider", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.state.Provider", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "name", @@ -75,15 +78,20 @@ }, { "name" : "decodeValue", + "type" : "function", "desc" : "Decodes a string previously encoded with {@link #encodeValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.state.Provider", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.state.Provider", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -102,15 +110,20 @@ }, { "name" : "get", + "type" : "function", "desc" : "Returns the current value for a key", + "sig" : "(name, defaultValue)", + "static" : false, + "memberOf" : "Roo.state.Provider", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.state.Provider", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "name", @@ -135,15 +148,20 @@ }, { "name" : "set", + "type" : "function", "desc" : "Sets the value for a key", + "sig" : "(name, value)", + "static" : false, + "memberOf" : "Roo.state.Provider", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.state.Provider", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "name", @@ -162,15 +180,20 @@ }, { "name" : "encodeValue", + "type" : "function", "desc" : "Encodes a value including type information. Decode with {@link #decodeValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.state.Provider", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.state.Provider", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -191,7 +214,9 @@ "events" : [ { "name" : "statechange", + "type" : "function", "desc" : "Fires when a state change occurs.", + "sig" : "function (_self, key, value)\n{\n\n}", "memberOf" : "Roo.state.Provider", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.state.Manager.json b/docs/symbols/Roo.state.Manager.json index 6816a42d3c..7e96263daf 100644 --- a/docs/symbols/Roo.state.Manager.json +++ b/docs/symbols/Roo.state.Manager.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "getProvider", + "type" : "function", "desc" : "Gets the currently configured state provider", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.state.Manager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -36,15 +43,20 @@ }, { "name" : "clear", + "type" : "function", "desc" : "Clears a value from the state", + "sig" : "(name)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.state.Manager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "name", @@ -57,15 +69,20 @@ }, { "name" : "get", + "type" : "function", "desc" : "Returns the current value for a key", + "sig" : "(name, defaultValue)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.state.Manager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "name", @@ -90,15 +107,20 @@ }, { "name" : "set", + "type" : "function", "desc" : "Sets the value for a key", + "sig" : "(name, value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.state.Manager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "name", @@ -117,15 +139,20 @@ }, { "name" : "setProvider", + "type" : "function", "desc" : "Configures the default state provider for your application", + "sig" : "(stateProvider)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.state.Manager", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "stateProvider", diff --git a/docs/symbols/Roo.state.Provider.json b/docs/symbols/Roo.state.Provider.json index 19d4122b6d..8fcf94063e 100644 --- a/docs/symbols/Roo.state.Provider.json +++ b/docs/symbols/Roo.state.Provider.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "clear", + "type" : "function", "desc" : "Clears a value from the state", + "sig" : "(name)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.state.Provider", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "name", @@ -37,15 +44,20 @@ }, { "name" : "decodeValue", + "type" : "function", "desc" : "Decodes a string previously encoded with {@link #encodeValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.state.Provider", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -64,15 +76,20 @@ }, { "name" : "get", + "type" : "function", "desc" : "Returns the current value for a key", + "sig" : "(name, defaultValue)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.state.Provider", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "name", @@ -97,15 +114,20 @@ }, { "name" : "set", + "type" : "function", "desc" : "Sets the value for a key", + "sig" : "(name, value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.state.Provider", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "name", @@ -124,15 +146,20 @@ }, { "name" : "encodeValue", + "type" : "function", "desc" : "Encodes a value including type information. Decode with {@link #decodeValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.state.Provider", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -153,8 +180,10 @@ "events" : [ { "name" : "statechange", + "type" : "function", "desc" : "Fires when a state change occurs.", - "memberOf" : "Roo.state.Provider", + "sig" : "function (_self, key, value)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.state.json b/docs/symbols/Roo.state.json index a4c21d7f50..5df05b4067 100644 --- a/docs/symbols/Roo.state.json +++ b/docs/symbols/Roo.state.json @@ -12,6 +12,8 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.tree.AsyncTreeNode.json b/docs/symbols/Roo.tree.AsyncTreeNode.json index 51537bdfff..3a30942332 100644 --- a/docs/symbols/Roo.tree.AsyncTreeNode.json +++ b/docs/symbols/Roo.tree.AsyncTreeNode.json @@ -23,153 +23,141 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "hrefTarget", "type" : "String", "desc" : "target frame for the link", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "Roo.tree.TreeNode" }, { "name" : "id", "type" : "String", "desc" : "The id for this node. If one is not specified, one is generated.", - "memberOf" : "Roo.data.Node", - "optvals" : [] + "memberOf" : "Roo.data.Node" }, { "name" : "text", "type" : "String", "desc" : "The text for this node", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "Roo.tree.TreeNode" }, { "name" : "uiProvider", "type" : "Function", "desc" : "A UI class to use for this node (defaults to Roo.tree.TreeNodeUI)", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "Roo.tree.TreeNode" }, { "name" : "expanded", "type" : "Boolean", "desc" : "true to start the node expanded", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "Roo.tree.TreeNode" }, { "name" : "qtipCfg", "type" : "String", "desc" : "An Ext QuickTip config for the node (used instead of qtip)", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "Roo.tree.TreeNode" }, { "name" : "allowDrop", "type" : "Boolean", "desc" : "false if this node cannot be drop on", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "Roo.tree.TreeNode" }, { "name" : "disabled", "type" : "Boolean", "desc" : "true to start the node disabled", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "Roo.tree.TreeNode" }, { "name" : "cls", "type" : "String", "desc" : "A css class to be added to the node", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "Roo.tree.TreeNode" }, { "name" : "iconCls", "type" : "String", "desc" : "A css class to be added to the nodes icon element for applying css background images", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "Roo.tree.TreeNode" }, { "name" : "allowDrag", "type" : "Boolean", "desc" : "false to make this node undraggable if DD is on (defaults to true)", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "Roo.tree.TreeNode" }, { "name" : "loader", "type" : "TreeLoader", "desc" : "A TreeLoader to be used by this node (defaults to the loader defined on the tree)", - "memberOf" : "Roo.tree.AsyncTreeNode", - "optvals" : [] + "memberOf" : "" }, { "name" : "icon", "type" : "String", "desc" : "The path to an icon for the node. The preferred way to do this", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "Roo.tree.TreeNode" }, { "name" : "singleClickExpand", "type" : "Boolean", "desc" : "True for single click expand on this node", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "Roo.tree.TreeNode" }, { "name" : "qtip", "type" : "String", "desc" : "An Ext QuickTip for the node", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "Roo.tree.TreeNode" }, { "name" : "checked", "type" : "Boolean", "desc" : "True to render a checked checkbox for this node, false to render an unchecked checkbox\n(defaults to undefined with no checkbox rendered)", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "Roo.tree.TreeNode" }, { "name" : "href", "type" : "String", "desc" : "URL of the link used for the node (defaults to #)", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "Roo.tree.TreeNode" }, { "name" : "leaf", "type" : "Boolean", "desc" : "true if this node is a leaf and does not have children", - "memberOf" : "Roo.data.Node", - "optvals" : [] + "memberOf" : "Roo.data.Node" } ], "methods" : [ { "name" : "isLoaded", + "type" : "function", "desc" : "Returns true if this node has been loaded", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.AsyncTreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -181,15 +169,20 @@ }, { "name" : "isLoading", + "type" : "function", "desc" : "Returns true if this node is currently loading", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.AsyncTreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -201,15 +194,20 @@ }, { "name" : "reload", + "type" : "function", "desc" : "Trigger a reload for this node", + "sig" : "(callback)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.AsyncTreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "callback", @@ -222,43 +220,58 @@ }, { "name" : "select", + "type" : "function", "desc" : "Triggers selection of this node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.tree.TreeNode", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "enable", + "type" : "function", "desc" : "Enables this node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.tree.TreeNode", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "collapseChildNodes", + "type" : "function", "desc" : "Collapse all child nodes", + "sig" : "(deep)", + "static" : false, + "memberOf" : "Roo.tree.TreeNode", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "deep", @@ -271,29 +284,39 @@ }, { "name" : "ensureVisible", + "type" : "function", "desc" : "Ensures all parent nodes are expanded", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.tree.TreeNode", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isSelected", + "type" : "function", "desc" : "Returns true if this node is selected", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.tree.TreeNode", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -305,29 +328,39 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disables this node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.tree.TreeNode", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getUI", + "type" : "function", "desc" : "Returns the UI object for this node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.tree.TreeNode", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -339,15 +372,20 @@ }, { "name" : "setText", + "type" : "function", "desc" : "Sets the text for this node", + "sig" : "(text)", + "static" : false, + "memberOf" : "Roo.tree.TreeNode", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "text", @@ -360,43 +398,58 @@ }, { "name" : "toggle", + "type" : "function", "desc" : "Toggles expanded/collapsed state of the node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.tree.TreeNode", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "unselect", + "type" : "function", "desc" : "Triggers deselection of this node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.tree.TreeNode", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isExpanded", + "type" : "function", "desc" : "Returns true if this node is expanded", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.tree.TreeNode", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -408,15 +461,20 @@ }, { "name" : "expandChildNodes", + "type" : "function", "desc" : "Expand all child nodes", + "sig" : "(deep)", + "static" : false, + "memberOf" : "Roo.tree.TreeNode", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "deep", @@ -429,15 +487,20 @@ }, { "name" : "expand", + "type" : "function", "desc" : "Expand this node.", + "sig" : "(deep, anim, callback)", + "static" : false, + "memberOf" : "Roo.tree.TreeNode", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "deep", @@ -462,15 +525,20 @@ }, { "name" : "collapse", + "type" : "function", "desc" : "Collapse this node.", + "sig" : "(deep, anim)", + "static" : false, + "memberOf" : "Roo.tree.TreeNode", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "deep", @@ -489,15 +557,20 @@ }, { "name" : "sort", + "type" : "function", "desc" : "Sorts this nodes children using the supplied sort function", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -516,15 +589,20 @@ }, { "name" : "removeChild", + "type" : "function", "desc" : "Removes a child node from this node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -543,15 +621,20 @@ }, { "name" : "isAncestor", + "type" : "function", "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -570,15 +653,20 @@ }, { "name" : "contains", + "type" : "function", "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -597,15 +685,20 @@ }, { "name" : "cascade", + "type" : "function", "desc" : "Cascades down the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch.", + "sig" : "(fn, scope, args)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -630,15 +723,20 @@ }, { "name" : "getDepth", + "type" : "function", "desc" : "Returns depth of this node (the root node has a depth of 0)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -650,15 +748,20 @@ }, { "name" : "getPath", + "type" : "function", "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.", + "sig" : "(attr)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "attr", @@ -677,15 +780,20 @@ }, { "name" : "indexOf", + "type" : "function", "desc" : "Returns the index of a child node", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -704,15 +812,20 @@ }, { "name" : "isFirst", + "type" : "function", "desc" : "Returns true if this node is the first child of its parent", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -724,15 +837,20 @@ }, { "name" : "isLast", + "type" : "function", "desc" : "Returns true if this node is the last child of its parent", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -744,15 +862,20 @@ }, { "name" : "isLeaf", + "type" : "function", "desc" : "Returns true if this node is a leaf", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -764,15 +887,20 @@ }, { "name" : "insertBefore", + "type" : "function", "desc" : "Inserts the first node before the second node in this nodes childNodes collection.", + "sig" : "(node, refNode)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -797,15 +925,20 @@ }, { "name" : "item", + "type" : "function", "desc" : "Returns the child node at the specified index.", + "sig" : "(index)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -824,15 +957,20 @@ }, { "name" : "getOwnerTree", + "type" : "function", "desc" : "Returns the tree this node is in.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -844,15 +982,20 @@ }, { "name" : "appendChild", + "type" : "function", "desc" : "Insert node(s) as the last child node of this node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -871,15 +1014,20 @@ }, { "name" : "findChildBy", + "type" : "function", "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -904,15 +1052,20 @@ }, { "name" : "replaceChild", + "type" : "function", "desc" : "Replaces one child node in this node with another.", + "sig" : "(newChild, oldChild)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "newChild", @@ -937,15 +1090,20 @@ }, { "name" : "bubble", + "type" : "function", "desc" : "Bubbles up the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped.", + "sig" : "(fn, scope, args)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -970,15 +1128,20 @@ }, { "name" : "eachChild", + "type" : "function", "desc" : "Interates the child nodes of this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops.", + "sig" : "(fn, scope, args)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -1003,15 +1166,20 @@ }, { "name" : "findChild", + "type" : "function", "desc" : "Finds the first child that has the attribute with the specified value.", + "sig" : "(attribute, value)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "attribute", @@ -1036,29 +1204,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1089,15 +1267,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1122,15 +1305,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1143,15 +1331,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1164,15 +1357,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1197,15 +1395,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1230,15 +1433,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1257,15 +1465,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1290,15 +1503,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1331,8 +1549,10 @@ "events" : [ { "name" : "load", + "type" : "function", "desc" : "Fires when this node is loaded", - "memberOf" : "Roo.tree.AsyncTreeNode", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1349,8 +1569,10 @@ }, { "name" : "beforeload", + "type" : "function", "desc" : "Fires before this node is loaded, return false to cancel", - "memberOf" : "Roo.tree.AsyncTreeNode", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1367,7 +1589,9 @@ }, { "name" : "beforecollapse", + "type" : "function", "desc" : "Fires before this node is collapsed, return false to cancel.", + "sig" : "function (_self, deep, anim)\n{\n\n}", "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", @@ -1397,7 +1621,9 @@ }, { "name" : "dblclick", + "type" : "function", "desc" : "Fires when this node is double clicked", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", @@ -1421,7 +1647,9 @@ }, { "name" : "disabledchange", + "type" : "function", "desc" : "Fires when the disabled status of this node changes", + "sig" : "function (_self, disabled)\n{\n\n}", "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", @@ -1445,7 +1673,9 @@ }, { "name" : "beforechildrenrendered", + "type" : "function", "desc" : "Fires right before the child nodes for this node are rendered", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", @@ -1463,7 +1693,9 @@ }, { "name" : "beforeclick", + "type" : "function", "desc" : "Fires before click processing. Return false to cancel the default action.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", @@ -1487,7 +1719,9 @@ }, { "name" : "checkchange", + "type" : "function", "desc" : "Fires when a node with a checkbox's checked property changes", + "sig" : "function (_self, checked)\n{\n\n}", "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", @@ -1511,7 +1745,9 @@ }, { "name" : "collapse", + "type" : "function", "desc" : "Fires when this node is collapsed", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", @@ -1529,7 +1765,9 @@ }, { "name" : "textchange", + "type" : "function", "desc" : "Fires when the text for this node is changed", + "sig" : "function (_self, text, oldText)\n{\n\n}", "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", @@ -1559,7 +1797,9 @@ }, { "name" : "beforeexpand", + "type" : "function", "desc" : "Fires before this node is expanded, return false to cancel.", + "sig" : "function (_self, deep, anim)\n{\n\n}", "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", @@ -1589,7 +1829,9 @@ }, { "name" : "click", + "type" : "function", "desc" : "Fires when this node is clicked", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", @@ -1613,7 +1855,9 @@ }, { "name" : "contextmenu", + "type" : "function", "desc" : "Fires when this node is right clicked", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", @@ -1637,7 +1881,9 @@ }, { "name" : "expand", + "type" : "function", "desc" : "Fires when this node is expanded", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", @@ -1655,7 +1901,9 @@ }, { "name" : "beforeappend", + "type" : "function", "desc" : "Fires before a new child is appended, return false to cancel the append.", + "sig" : "function (tree, _self, node)\n{\n\n}", "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", @@ -1685,7 +1933,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires when this node is moved to a new location in the tree", + "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}", "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", @@ -1727,7 +1977,9 @@ }, { "name" : "append", + "type" : "function", "desc" : "Fires when a new child node is appended", + "sig" : "function (tree, _self, node, index)\n{\n\n}", "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", @@ -1763,7 +2015,9 @@ }, { "name" : "beforeremove", + "type" : "function", "desc" : "Fires before a child is removed, return false to cancel the remove.", + "sig" : "function (tree, _self, node)\n{\n\n}", "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", @@ -1793,7 +2047,9 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Fires when a child node is removed", + "sig" : "function (tree, _self, node)\n{\n\n}", "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", @@ -1823,7 +2079,9 @@ }, { "name" : "beforeinsert", + "type" : "function", "desc" : "Fires before a new child is inserted, return false to cancel the insert.", + "sig" : "function (tree, _self, node, refNode)\n{\n\n}", "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", @@ -1859,7 +2117,9 @@ }, { "name" : "insert", + "type" : "function", "desc" : "Fires when a new child node is inserted.", + "sig" : "function (tree, _self, node, refNode)\n{\n\n}", "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", @@ -1895,7 +2155,9 @@ }, { "name" : "beforemove", + "type" : "function", "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.", + "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}", "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.tree.ColumnTree.json b/docs/symbols/Roo.tree.ColumnTree.json index 60bf615dcc..99274ac3f8 100644 --- a/docs/symbols/Roo.tree.ColumnTree.json +++ b/docs/symbols/Roo.tree.ColumnTree.json @@ -25,28 +25,30 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "columns", "type" : "Object", "desc" : "Including width, header, renderer, cls, dataIndex", - "memberOf" : "Roo.tree.ColumnTree", - "optvals" : [] + "memberOf" : "" }, { "name" : "borderWidth", "type" : "int", "desc" : "compined right/left border allowance", - "memberOf" : "Roo.tree.ColumnTree", - "optvals" : [] + "memberOf" : "" } ], "methods" : [], "events" : [ { "name" : "resize", + "type" : "function", "desc" : "Fire this event on a container when it resizes", - "memberOf" : "Roo.tree.ColumnTree", + "sig" : "function (w, h)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.tree.DefaultSelectionModel.json b/docs/symbols/Roo.tree.DefaultSelectionModel.json index caffae6aa9..8ac10478d5 100644 --- a/docs/symbols/Roo.tree.DefaultSelectionModel.json +++ b/docs/symbols/Roo.tree.DefaultSelectionModel.json @@ -21,27 +21,33 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" } ], "methods" : [ { "name" : "getSelectedNode", + "type" : "function", "desc" : "Get the selected node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.DefaultSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -53,29 +59,39 @@ }, { "name" : "clearSelections", + "type" : "function", "desc" : "Clear all selections", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.DefaultSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isSelected", + "type" : "function", "desc" : "Returns true if the node is selected", + "sig" : "(node)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.DefaultSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -94,15 +110,20 @@ }, { "name" : "selectPrevious", + "type" : "function", "desc" : "Selects the node above the selected node in the tree, intelligently walking the nodes", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.DefaultSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -114,15 +135,20 @@ }, { "name" : "unselect", + "type" : "function", "desc" : "Deselect a node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.DefaultSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -135,15 +161,20 @@ }, { "name" : "select", + "type" : "function", "desc" : "Select a node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.DefaultSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -162,15 +193,20 @@ }, { "name" : "selectNext", + "type" : "function", "desc" : "Selects the node above the selected node in the tree, intelligently walking the nodes", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.DefaultSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -182,29 +218,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -235,15 +281,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -268,15 +319,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -289,15 +345,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -310,15 +371,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -343,15 +409,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -376,15 +447,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -403,15 +479,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -436,15 +517,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -477,8 +563,10 @@ "events" : [ { "name" : "selectionchange", + "type" : "function", "desc" : "Fires when the selected node changes", - "memberOf" : "Roo.tree.DefaultSelectionModel", + "sig" : "function (_self, node)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -501,8 +589,10 @@ }, { "name" : "beforeselect", + "type" : "function", "desc" : "Fires before the selected node changes, return false to cancel the change", - "memberOf" : "Roo.tree.DefaultSelectionModel", + "sig" : "function (_self, node, node)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.tree.MultiSelectionModel.json b/docs/symbols/Roo.tree.MultiSelectionModel.json index 21240e72a4..c3a81780e0 100644 --- a/docs/symbols/Roo.tree.MultiSelectionModel.json +++ b/docs/symbols/Roo.tree.MultiSelectionModel.json @@ -21,27 +21,33 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" } ], "methods" : [ { "name" : "getSelectedNodes", + "type" : "function", "desc" : "Returns an array of the selected nodes", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.MultiSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -53,29 +59,39 @@ }, { "name" : "clearSelections", + "type" : "function", "desc" : "Clear all selections", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.MultiSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isSelected", + "type" : "function", "desc" : "Returns true if the node is selected", + "sig" : "(node)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.MultiSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -94,15 +110,20 @@ }, { "name" : "unselect", + "type" : "function", "desc" : "Deselect a node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.MultiSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -115,15 +136,20 @@ }, { "name" : "select", + "type" : "function", "desc" : "Select a node.", + "sig" : "(node, e, keepExisting)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.MultiSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -154,29 +180,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -207,15 +243,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -240,15 +281,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -261,15 +307,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -282,15 +333,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -315,15 +371,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -348,15 +409,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -375,15 +441,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -408,15 +479,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -449,8 +525,10 @@ "events" : [ { "name" : "selectionchange", + "type" : "function", "desc" : "Fires when the selected nodes change", - "memberOf" : "Roo.tree.MultiSelectionModel", + "sig" : "function (_self, nodes)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.tree.TreeEditor.json b/docs/symbols/Roo.tree.TreeEditor.json index b01e52c4b0..c313984a10 100644 --- a/docs/symbols/Roo.tree.TreeEditor.json +++ b/docs/symbols/Roo.tree.TreeEditor.json @@ -29,170 +29,153 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "alignment", "type" : "String", "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to \"l-l\").", - "memberOf" : "Roo.tree.TreeEditor", - "optvals" : [] + "memberOf" : "" }, { "name" : "hideEl", "type" : "Boolean", "desc" : "True to hide the bound element while the editor is displayed (defaults to false)", - "memberOf" : "Roo.tree.TreeEditor", - "optvals" : [] + "memberOf" : "" }, { "name" : "maxWidth", "type" : "Number", "desc" : "The maximum width in pixels of the editor field (defaults to 250). Note that if the maxWidth would exceed\nthe containing tree element's size, it will be automatically limited for you to the container width, taking\nscroll and client offsets into account prior to each edit.", - "memberOf" : "Roo.tree.TreeEditor", - "optvals" : [] + "memberOf" : "" }, { "name" : "constrain", "type" : "Boolean", "desc" : "True to constrain the editor to the viewport", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "Roo.Editor" }, { "name" : "shadow", "type" : "Boolean/String", "desc" : "\"sides\" for sides/bottom only, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"frame\")", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "Roo.Editor" }, { "name" : "field", - "type" : "Roo.form.TextField|Object", - "desc" : "The field configuration", - "memberOf" : "Roo.tree.TreeEditor", - "optvals" : [] + "type" : "Roo.form.TextField", + "desc" : "[required] The field configuration", + "memberOf" : "" }, { "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", - "optvals" : [ - "display", - "visibility" - ] + "memberOf" : "Roo.Component" }, { "name" : "value", "type" : "Mixed", "desc" : "The data value of the underlying field (defaults to \"\")", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "Roo.Editor" }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "cls", "type" : "String", "desc" : "CSS class to apply to the editor (defaults to \"x-small-editor x-tree-editor\")", - "memberOf" : "Roo.tree.TreeEditor", - "optvals" : [] + "memberOf" : "" }, { "name" : "shim", "type" : "Boolean", "desc" : "True to shim the editor if selects/iframes could be displayed beneath it (defaults to false)", - "memberOf" : "Roo.tree.TreeEditor", - "optvals" : [] + "memberOf" : "" }, { "name" : "cancelOnEsc", "type" : "Boolean", "desc" : "True to cancel the edit when the escape key is pressed (defaults to false)", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "Roo.Editor" }, { "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", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "completeOnEnter", "type" : "Boolean", "desc" : "True to complete the edit when the enter key is pressed (defaults to false)", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "Roo.Editor" }, { "name" : "revertInvalid", "type" : "Boolean", "desc" : "True to automatically revert the field value and cancel the edit when the user completes an edit and the field\nvalidation fails (defaults to true)", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "Roo.Editor" }, { "name" : "tree", "type" : "Roo.tree.TreePanel", "desc" : "The tree to bind to.", - "memberOf" : "Roo.tree.TreeEditor", - "optvals" : [] + "memberOf" : "" }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", - "memberOf" : "Roo.Component", - "optvals" : [] + "memberOf" : "Roo.Component" }, { "name" : "ignoreNoChange", "type" : "Boolean", "desc" : "True to skip the the edit completion process (no save, no events fired) if the user completes an edit and\nthe value has not changed (defaults to false). Applies only to string values - edits for other data types\nwill never be ignored.", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "Roo.Editor" }, { "name" : "autosize", "type" : "Boolean/String", "desc" : "True for the editor to automatically adopt the size of the underlying field, \"width\" to adopt the width only,\nor \"height\" to adopt the height only (defaults to false)", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "Roo.Editor" }, { "name" : "updateEl", "type" : "Boolean", "desc" : "True to update the innerHTML of the bound element when the update completes (defaults to false)", - "memberOf" : "Roo.Editor", - "optvals" : [] + "memberOf" : "Roo.Editor" } ], "methods" : [ { "name" : "cancelEdit", + "type" : "function", "desc" : "Cancels the editing process and hides the editor without persisting any changes. The field value will be\nreverted to the original starting value.", + "sig" : "(remainVisible)", + "static" : false, + "memberOf" : "Roo.Editor", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "remainVisible", @@ -205,15 +188,20 @@ }, { "name" : "setSize", + "type" : "function", "desc" : "Sets the height and width of this editor.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.Editor", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -232,29 +220,39 @@ }, { "name" : "realign", + "type" : "function", "desc" : "Realigns the editor to the bound field based on the current alignment config value.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Editor", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getValue", + "type" : "function", "desc" : "Gets the data value of the editor", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Editor", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -266,15 +264,20 @@ }, { "name" : "completeEdit", + "type" : "function", "desc" : "Ends the editing process, persists the changed value to the underlying field, and hides the editor.", + "sig" : "(remainVisible)", + "static" : false, + "memberOf" : "Roo.Editor", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "remainVisible", @@ -287,15 +290,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets the data value of the editor", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.Editor", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -308,15 +316,20 @@ }, { "name" : "startEdit", + "type" : "function", "desc" : "Starts the editing process and shows the editor.", + "sig" : "(el, value)", + "static" : false, + "memberOf" : "Roo.Editor", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -335,15 +348,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -355,15 +373,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -376,43 +399,58 @@ }, { "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -425,15 +463,20 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -445,15 +488,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -472,15 +520,20 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -492,15 +545,20 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -512,15 +570,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -539,15 +602,20 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -559,15 +627,20 @@ }, { "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, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -579,29 +652,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -632,15 +715,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -665,15 +753,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -686,15 +779,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -707,15 +805,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -740,15 +843,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -773,15 +881,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -800,15 +913,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -833,15 +951,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -874,8 +997,10 @@ "events" : [ { "name" : "beforenodeedit", + "type" : "function", "desc" : "Fires when editing is initiated, but before the value changes. Editing can be canceled by returning\nfalse from the handler of this event.", - "memberOf" : "Roo.tree.TreeEditor", + "sig" : "function (_self, node)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -898,7 +1023,9 @@ }, { "name" : "beforestartedit", + "type" : "function", "desc" : "Fires when editing is initiated, but before the value changes. Editing can be canceled by returning\nfalse from the handler of this event.", + "sig" : "function (_self, boundEl, value)\n{\n\n}", "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", @@ -928,7 +1055,9 @@ }, { "name" : "beforecomplete", + "type" : "function", "desc" : "Fires after a change has been made to the field, but before the change is reflected in the underlying\nfield. Saving the change to the field can be canceled by returning false from the handler of this event.\nNote that if the value has not changed and ignoreNoChange = true, the editing will still end but this\nevent will not fire since no edit actually occurred.", + "sig" : "function (_self, value, startValue)\n{\n\n}", "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", @@ -958,7 +1087,9 @@ }, { "name" : "complete", + "type" : "function", "desc" : "Fires after editing is complete and any changed value has been written to the underlying field.", + "sig" : "function (_self, value, startValue)\n{\n\n}", "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", @@ -988,7 +1119,9 @@ }, { "name" : "specialkey", + "type" : "function", "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", @@ -1012,7 +1145,9 @@ }, { "name" : "startedit", + "type" : "function", "desc" : "Fires when this editor is displayed", + "sig" : "function (boundEl, value)\n{\n\n}", "memberOf" : "Roo.Editor", "example" : "", "deprecated" : "", @@ -1036,7 +1171,9 @@ }, { "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" : "", @@ -1054,7 +1191,9 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1072,7 +1211,9 @@ }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1090,7 +1231,9 @@ }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1108,7 +1251,9 @@ }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1126,7 +1271,9 @@ }, { "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" : "", @@ -1144,7 +1291,9 @@ }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1162,7 +1311,9 @@ }, { "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" : "", @@ -1180,7 +1331,9 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1198,7 +1351,9 @@ }, { "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" : "", diff --git a/docs/symbols/Roo.tree.TreeFilter.json b/docs/symbols/Roo.tree.TreeFilter.json index b2a2706edc..e707f9331a 100644 --- a/docs/symbols/Roo.tree.TreeFilter.json +++ b/docs/symbols/Roo.tree.TreeFilter.json @@ -25,33 +25,45 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "clear", + "type" : "function", "desc" : "Clears the current filter. Note: with the \"remove\" option\nset a filter cannot be cleared.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeFilter", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "filter", + "type" : "function", "desc" : "Filter the data by a specific attribute.", + "sig" : "(value, attr, startNode)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeFilter", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -76,15 +88,20 @@ }, { "name" : "filterBy", + "type" : "function", "desc" : "Filter by a function. The passed function will be called with each\nnode in the tree (or from the startNode). If the function returns true, the node is kept\notherwise it is filtered. If a node is filtered, its children are also filtered.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeFilter", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", diff --git a/docs/symbols/Roo.tree.TreeLoader.json b/docs/symbols/Roo.tree.TreeLoader.json index f343bb49fb..ee8d32422a 100644 --- a/docs/symbols/Roo.tree.TreeLoader.json +++ b/docs/symbols/Roo.tree.TreeLoader.json @@ -21,83 +21,81 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "clearOnLoad", "type" : "Boolean", "desc" : "(optional) Default to true. Remove previously existing\nchild nodes before loading.", - "memberOf" : "Roo.tree.TreeLoader", - "optvals" : [] + "memberOf" : "" }, { "name" : "dataUrl", "type" : "String", "desc" : "The URL from which to request a Json string which\nspecifies an array of node definition object representing the child nodes\nto be loaded.", - "memberOf" : "Roo.tree.TreeLoader", - "optvals" : [] + "memberOf" : "" }, { "name" : "root", "type" : "String", "desc" : "(optional) Default to false. Use this to read data from an object \nproperty on loading, rather than expecting an array. (eg. more compatible to a standard\nGrid query { data : [ .....] }", - "memberOf" : "Roo.tree.TreeLoader", - "optvals" : [] + "memberOf" : "" }, { "name" : "requestMethod", "type" : "String", "desc" : "either GET or POST\ndefaults to POST (due to BC)\nto be loaded.", - "memberOf" : "Roo.tree.TreeLoader", - "optvals" : [] + "memberOf" : "" }, { "name" : "baseParams", "type" : "Object", "desc" : "(optional) An object containing properties which\nspecify HTTP parameters to be passed to each request for child nodes.", - "memberOf" : "Roo.tree.TreeLoader", - "optvals" : [] + "memberOf" : "" }, { "name" : "baseAttrs", "type" : "Object", "desc" : "(optional) An object containing attributes to be added to all nodes\ncreated by this loader. If the attributes sent by the server have an attribute in this object,\nthey take priority.", - "memberOf" : "Roo.tree.TreeLoader", - "optvals" : [] + "memberOf" : "" }, { "name" : "uiProviders", "type" : "Object", "desc" : "(optional) An object containing properties which\n\nDEPRECATED - use 'create' event handler to modify attributes - which affect creation.\nspecify custom {@link Roo.tree.TreeNodeUI} implementations. If the optional\nuiProvider attribute of a returned child node is a string rather\nthan a reference to a TreeNodeUI implementation, this that string value\nis used as a property name in the uiProviders object. You can define the provider named\n'default' , and this will be used for all nodes (if no uiProvider is delivered by the node data)", - "memberOf" : "Roo.tree.TreeLoader", - "optvals" : [] + "memberOf" : "" }, { "name" : "queryParam", "type" : "String", "desc" : "(optional) \nName of the query as it will be passed on the querystring (defaults to 'node')\neg. the request will be ?node=[id]", - "memberOf" : "Roo.tree.TreeLoader", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "load", + "type" : "function", "desc" : "Load an {@link Roo.tree.TreeNode} from the URL specified in the constructor.\nThis is called automatically when a node is expanded, but may be used to reload\na node (or append new children if the {@link #clearOnLoad} option is false.)", + "sig" : "(node, callback)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeLoader", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -116,29 +114,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -169,15 +177,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -202,15 +215,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -223,15 +241,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -244,15 +267,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -277,15 +305,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -310,15 +343,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -337,15 +375,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -370,15 +413,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -411,8 +459,10 @@ "events" : [ { "name" : "create", + "type" : "function", "desc" : "Fires before a node is created, enabling you to return custom Node types", - "memberOf" : "Roo.tree.TreeLoader", + "sig" : "function (This, attr)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -435,8 +485,10 @@ }, { "name" : "beforeload", + "type" : "function", "desc" : "Fires before a network request is made to retrieve the Json text which specifies a node's children.", - "memberOf" : "Roo.tree.TreeLoader", + "sig" : "function (This, node, callback)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -465,8 +517,10 @@ }, { "name" : "load", + "type" : "function", "desc" : "Fires when the node has been successfuly loaded.", - "memberOf" : "Roo.tree.TreeLoader", + "sig" : "function (This, node, response)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -495,8 +549,10 @@ }, { "name" : "loadexception", + "type" : "function", "desc" : "Fires if the network request failed.", - "memberOf" : "Roo.tree.TreeLoader", + "sig" : "function (This, node, response)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.tree.TreeNode.json b/docs/symbols/Roo.tree.TreeNode.json index 082866f0a5..7b7bf242ee 100644 --- a/docs/symbols/Roo.tree.TreeNode.json +++ b/docs/symbols/Roo.tree.TreeNode.json @@ -22,174 +22,173 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "hrefTarget", "type" : "String", "desc" : "target frame for the link", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "" }, { "name" : "id", "type" : "String", "desc" : "The id for this node. If one is not specified, one is generated.", - "memberOf" : "Roo.data.Node", - "optvals" : [] + "memberOf" : "Roo.data.Node" }, { "name" : "text", "type" : "String", "desc" : "The text for this node", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "" }, { "name" : "uiProvider", "type" : "Function", "desc" : "A UI class to use for this node (defaults to Roo.tree.TreeNodeUI)", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "" }, { "name" : "expanded", "type" : "Boolean", "desc" : "true to start the node expanded", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "" }, { "name" : "qtipCfg", "type" : "String", "desc" : "An Ext QuickTip config for the node (used instead of qtip)", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowDrop", "type" : "Boolean", "desc" : "false if this node cannot be drop on", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "" }, { "name" : "disabled", "type" : "Boolean", "desc" : "true to start the node disabled", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "" }, { "name" : "cls", "type" : "String", "desc" : "A css class to be added to the node", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "" }, { "name" : "iconCls", "type" : "String", "desc" : "A css class to be added to the nodes icon element for applying css background images", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "" }, { "name" : "allowDrag", "type" : "Boolean", "desc" : "false to make this node undraggable if DD is on (defaults to true)", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "" }, { "name" : "icon", "type" : "String", "desc" : "The path to an icon for the node. The preferred way to do this", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "" }, { "name" : "singleClickExpand", "type" : "Boolean", "desc" : "True for single click expand on this node", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "" }, { "name" : "qtip", "type" : "String", "desc" : "An Ext QuickTip for the node", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "" }, { "name" : "checked", "type" : "Boolean", "desc" : "True to render a checked checkbox for this node, false to render an unchecked checkbox\n(defaults to undefined with no checkbox rendered)", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "" }, { "name" : "href", "type" : "String", "desc" : "URL of the link used for the node (defaults to #)", - "memberOf" : "Roo.tree.TreeNode", - "optvals" : [] + "memberOf" : "" }, { "name" : "leaf", "type" : "Boolean", "desc" : "true if this node is a leaf and does not have children", - "memberOf" : "Roo.data.Node", - "optvals" : [] + "memberOf" : "Roo.data.Node" } ], "methods" : [ { "name" : "select", + "type" : "function", "desc" : "Triggers selection of this node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "enable", + "type" : "function", "desc" : "Enables this node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "collapseChildNodes", + "type" : "function", "desc" : "Collapse all child nodes", + "sig" : "(deep)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "deep", @@ -202,29 +201,39 @@ }, { "name" : "ensureVisible", + "type" : "function", "desc" : "Ensures all parent nodes are expanded", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isSelected", + "type" : "function", "desc" : "Returns true if this node is selected", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -236,29 +245,39 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disables this node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getUI", + "type" : "function", "desc" : "Returns the UI object for this node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -270,15 +289,20 @@ }, { "name" : "setText", + "type" : "function", "desc" : "Sets the text for this node", + "sig" : "(text)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "text", @@ -291,43 +315,58 @@ }, { "name" : "toggle", + "type" : "function", "desc" : "Toggles expanded/collapsed state of the node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "unselect", + "type" : "function", "desc" : "Triggers deselection of this node", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isExpanded", + "type" : "function", "desc" : "Returns true if this node is expanded", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -339,15 +378,20 @@ }, { "name" : "expandChildNodes", + "type" : "function", "desc" : "Expand all child nodes", + "sig" : "(deep)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "deep", @@ -360,15 +404,20 @@ }, { "name" : "expand", + "type" : "function", "desc" : "Expand this node.", + "sig" : "(deep, anim, callback)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "deep", @@ -393,15 +442,20 @@ }, { "name" : "collapse", + "type" : "function", "desc" : "Collapse this node.", + "sig" : "(deep, anim)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreeNode", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "deep", @@ -420,15 +474,20 @@ }, { "name" : "sort", + "type" : "function", "desc" : "Sorts this nodes children using the supplied sort function", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -447,15 +506,20 @@ }, { "name" : "removeChild", + "type" : "function", "desc" : "Removes a child node from this node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -474,15 +538,20 @@ }, { "name" : "isAncestor", + "type" : "function", "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -501,15 +570,20 @@ }, { "name" : "contains", + "type" : "function", "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -528,15 +602,20 @@ }, { "name" : "cascade", + "type" : "function", "desc" : "Cascades down the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch.", + "sig" : "(fn, scope, args)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -561,15 +640,20 @@ }, { "name" : "getDepth", + "type" : "function", "desc" : "Returns depth of this node (the root node has a depth of 0)", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -581,15 +665,20 @@ }, { "name" : "getPath", + "type" : "function", "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.", + "sig" : "(attr)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "attr", @@ -608,15 +697,20 @@ }, { "name" : "indexOf", + "type" : "function", "desc" : "Returns the index of a child node", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -635,15 +729,20 @@ }, { "name" : "isFirst", + "type" : "function", "desc" : "Returns true if this node is the first child of its parent", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -655,15 +754,20 @@ }, { "name" : "isLast", + "type" : "function", "desc" : "Returns true if this node is the last child of its parent", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -675,15 +779,20 @@ }, { "name" : "isLeaf", + "type" : "function", "desc" : "Returns true if this node is a leaf", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -695,15 +804,20 @@ }, { "name" : "insertBefore", + "type" : "function", "desc" : "Inserts the first node before the second node in this nodes childNodes collection.", + "sig" : "(node, refNode)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -728,15 +842,20 @@ }, { "name" : "item", + "type" : "function", "desc" : "Returns the child node at the specified index.", + "sig" : "(index)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -755,15 +874,20 @@ }, { "name" : "getOwnerTree", + "type" : "function", "desc" : "Returns the tree this node is in.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -775,15 +899,20 @@ }, { "name" : "appendChild", + "type" : "function", "desc" : "Insert node(s) as the last child node of this node.", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -802,15 +931,20 @@ }, { "name" : "findChildBy", + "type" : "function", "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -835,15 +969,20 @@ }, { "name" : "replaceChild", + "type" : "function", "desc" : "Replaces one child node in this node with another.", + "sig" : "(newChild, oldChild)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "newChild", @@ -868,15 +1007,20 @@ }, { "name" : "bubble", + "type" : "function", "desc" : "Bubbles up the tree from this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped.", + "sig" : "(fn, scope, args)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -901,15 +1045,20 @@ }, { "name" : "eachChild", + "type" : "function", "desc" : "Interates the child nodes of this node, calling the specified function with each node. The scope (this) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops.", + "sig" : "(fn, scope, args)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -934,15 +1083,20 @@ }, { "name" : "findChild", + "type" : "function", "desc" : "Finds the first child that has the attribute with the specified value.", + "sig" : "(attribute, value)", + "static" : false, + "memberOf" : "Roo.data.Node", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "attribute", @@ -967,29 +1121,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1020,15 +1184,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1053,15 +1222,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -1074,15 +1248,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1095,15 +1274,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1128,15 +1312,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1161,15 +1350,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1188,15 +1382,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1221,15 +1420,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1262,8 +1466,10 @@ "events" : [ { "name" : "beforecollapse", + "type" : "function", "desc" : "Fires before this node is collapsed, return false to cancel.", - "memberOf" : "Roo.tree.TreeNode", + "sig" : "function (_self, deep, anim)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1292,8 +1498,10 @@ }, { "name" : "dblclick", + "type" : "function", "desc" : "Fires when this node is double clicked", - "memberOf" : "Roo.tree.TreeNode", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1316,8 +1524,10 @@ }, { "name" : "disabledchange", + "type" : "function", "desc" : "Fires when the disabled status of this node changes", - "memberOf" : "Roo.tree.TreeNode", + "sig" : "function (_self, disabled)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1340,8 +1550,10 @@ }, { "name" : "beforechildrenrendered", + "type" : "function", "desc" : "Fires right before the child nodes for this node are rendered", - "memberOf" : "Roo.tree.TreeNode", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1358,8 +1570,10 @@ }, { "name" : "beforeclick", + "type" : "function", "desc" : "Fires before click processing. Return false to cancel the default action.", - "memberOf" : "Roo.tree.TreeNode", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1382,8 +1596,10 @@ }, { "name" : "checkchange", + "type" : "function", "desc" : "Fires when a node with a checkbox's checked property changes", - "memberOf" : "Roo.tree.TreeNode", + "sig" : "function (_self, checked)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1406,8 +1622,10 @@ }, { "name" : "collapse", + "type" : "function", "desc" : "Fires when this node is collapsed", - "memberOf" : "Roo.tree.TreeNode", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1424,8 +1642,10 @@ }, { "name" : "textchange", + "type" : "function", "desc" : "Fires when the text for this node is changed", - "memberOf" : "Roo.tree.TreeNode", + "sig" : "function (_self, text, oldText)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1454,8 +1674,10 @@ }, { "name" : "beforeexpand", + "type" : "function", "desc" : "Fires before this node is expanded, return false to cancel.", - "memberOf" : "Roo.tree.TreeNode", + "sig" : "function (_self, deep, anim)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1484,8 +1706,10 @@ }, { "name" : "click", + "type" : "function", "desc" : "Fires when this node is clicked", - "memberOf" : "Roo.tree.TreeNode", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1508,8 +1732,10 @@ }, { "name" : "contextmenu", + "type" : "function", "desc" : "Fires when this node is right clicked", - "memberOf" : "Roo.tree.TreeNode", + "sig" : "function (_self, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1532,8 +1758,10 @@ }, { "name" : "expand", + "type" : "function", "desc" : "Fires when this node is expanded", - "memberOf" : "Roo.tree.TreeNode", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1550,7 +1778,9 @@ }, { "name" : "beforeappend", + "type" : "function", "desc" : "Fires before a new child is appended, return false to cancel the append.", + "sig" : "function (tree, _self, node)\n{\n\n}", "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", @@ -1580,7 +1810,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires when this node is moved to a new location in the tree", + "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}", "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", @@ -1622,7 +1854,9 @@ }, { "name" : "append", + "type" : "function", "desc" : "Fires when a new child node is appended", + "sig" : "function (tree, _self, node, index)\n{\n\n}", "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", @@ -1658,7 +1892,9 @@ }, { "name" : "beforeremove", + "type" : "function", "desc" : "Fires before a child is removed, return false to cancel the remove.", + "sig" : "function (tree, _self, node)\n{\n\n}", "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", @@ -1688,7 +1924,9 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Fires when a child node is removed", + "sig" : "function (tree, _self, node)\n{\n\n}", "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", @@ -1718,7 +1956,9 @@ }, { "name" : "beforeinsert", + "type" : "function", "desc" : "Fires before a new child is inserted, return false to cancel the insert.", + "sig" : "function (tree, _self, node, refNode)\n{\n\n}", "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", @@ -1754,7 +1994,9 @@ }, { "name" : "insert", + "type" : "function", "desc" : "Fires when a new child node is inserted.", + "sig" : "function (tree, _self, node, refNode)\n{\n\n}", "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", @@ -1790,7 +2032,9 @@ }, { "name" : "beforemove", + "type" : "function", "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.", + "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}", "memberOf" : "Roo.data.Node", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.tree.TreeNodeUI.json b/docs/symbols/Roo.tree.TreeNodeUI.json index db19c514f7..2b6d211a79 100644 --- a/docs/symbols/Roo.tree.TreeNodeUI.json +++ b/docs/symbols/Roo.tree.TreeNodeUI.json @@ -19,6 +19,8 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.tree.TreePanel.json b/docs/symbols/Roo.tree.TreePanel.json index 7e9209f07d..7a70c8c611 100644 --- a/docs/symbols/Roo.tree.TreePanel.json +++ b/docs/symbols/Roo.tree.TreePanel.json @@ -28,216 +28,222 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "editor", - "type" : "Object|Roo.tree.TreeEditor", - "desc" : "The TreeEditor or xtype data to display when clicked.", - "memberOf" : "Roo.tree.TreePanel", - "optvals" : [] + "type" : "Roo.tree.TreeEditor", + "desc" : "The TreeEditor to display when clicked.", + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "singleExpand", "type" : "Boolean", "desc" : "true if only 1 node per branch may be expanded", - "memberOf" : "Roo.tree.TreePanel", - "optvals" : [] + "memberOf" : "" + }, + { + "name" : "root", + "type" : "Roo.tree.TreeNode", + "desc" : "The root node", + "memberOf" : "" }, { "name" : "ddAppendOnly", "type" : "String", "desc" : "True if the tree should only allow append drops (use for trees which are sorted)", - "memberOf" : "Roo.tree.TreePanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "dragConfig", "type" : "Object", "desc" : "Custom config to pass to the {@link Roo.tree.TreeDragZone} instance", - "memberOf" : "Roo.tree.TreePanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "enableDrop", "type" : "Boolean", "desc" : "true to enable just drop", - "memberOf" : "Roo.tree.TreePanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "hlColor", "type" : "String", "desc" : "The color of the node highlight (defaults to C3DAF9)", - "memberOf" : "Roo.tree.TreePanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "rendererTip", "type" : "Function", "desc" : "DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes hovertip to return HTML markup for the tree view. The render function is called with the following parameters:
    • The {Object} The data for the node.
    ", - "memberOf" : "Roo.tree.TreePanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "enableDD", "type" : "Boolean", "desc" : "true to enable drag and drop", - "memberOf" : "Roo.tree.TreePanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "hlDrop", "type" : "Boolean", "desc" : "false to disable node highlight on drop (defaults to the value of Roo.enableFx)", - "memberOf" : "Roo.tree.TreePanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "renderer", "type" : "Function", "desc" : "DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes. to return HTML markup for the tree view. The render function is called with the following parameters:
    • The {Object} The data for the node.
    ", - "memberOf" : "Roo.tree.TreePanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "rootVisible", "type" : "Boolean", "desc" : "false to hide the root node (defaults to true)", - "memberOf" : "Roo.tree.TreePanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "enableDrag", "type" : "Boolean", "desc" : "true to enable just drag", - "memberOf" : "Roo.tree.TreePanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "ddGroup", "type" : "String", "desc" : "The DD group this TreePanel belongs to", - "memberOf" : "Roo.tree.TreePanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "lines", "type" : "Boolean", "desc" : "false to disable tree lines (defaults to true)", - "memberOf" : "Roo.tree.TreePanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "dropConfig", "type" : "Object", "desc" : "Custom config to pass to the {@link Roo.tree.TreeDropZone} instance", - "memberOf" : "Roo.tree.TreePanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "selModel", "type" : "Boolean", "desc" : "A tree selection model to use with this TreePanel (defaults to a {@link Roo.tree.DefaultSelectionModel})", - "memberOf" : "Roo.tree.TreePanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "loader", - "type" : "Boolean", + "type" : "Roo.tree.TreeLoader", "desc" : "A TreeLoader for use with this TreePanel", - "memberOf" : "Roo.tree.TreePanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "containerScroll", "type" : "Boolean", "desc" : "true to register this container with ScrollManager", - "memberOf" : "Roo.tree.TreePanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "ddScroll", "type" : "Boolean", "desc" : "true to enable YUI body scrolling", - "memberOf" : "Roo.tree.TreePanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "animate", "type" : "Boolean", "desc" : "true to enable animated expand/collapse (defaults to the value of Roo.enableFx)", - "memberOf" : "Roo.tree.TreePanel", - "optvals" : [] + "memberOf" : "" }, { "name" : "pathSeparator", "type" : "String", "desc" : "The token used to separate sub-paths in path strings (defaults to '/')", - "memberOf" : "Roo.tree.TreePanel", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "getLoader", + "type" : "function", "desc" : "Returns the default TreeLoader for this TreePanel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreePanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "render", + "type" : "function", "desc" : "Trigger rendering of this TreePanel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreePanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getSelectionModel", + "type" : "function", "desc" : "Returns the selection model used by this TreePanel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreePanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "expandPath", + "type" : "function", "desc" : "Expands a specified path in this TreePanel. A path can be retrieved from a node with {@link Roo.data.Node#getPath}", + "sig" : "(path, attr, callback)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreePanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "path", @@ -262,29 +268,39 @@ }, { "name" : "expandAll", + "type" : "function", "desc" : "Expand all nodes", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreePanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "getChecked", + "type" : "function", "desc" : "Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. \"id\")", + "sig" : "(attribute, startNode)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreePanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "attribute", @@ -309,15 +325,20 @@ }, { "name" : "selectPath", + "type" : "function", "desc" : "Selects the node in this tree at the specified path. A path can be retrieved from a node with {@link Roo.data.Node#getPath}", + "sig" : "(path, attr, callback)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreePanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "path", @@ -342,43 +363,58 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the container element for this TreePanel", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreePanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "collapseAll", + "type" : "function", "desc" : "Collapse all nodes", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.tree.TreePanel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "setRootNode", + "type" : "function", "desc" : "Sets the root node for this tree.", + "sig" : "(node)", + "static" : false, + "memberOf" : "Roo.data.Tree", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Tree", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "node", @@ -397,15 +433,20 @@ }, { "name" : "getRootNode", + "type" : "function", "desc" : "Returns the root node for this tree.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.data.Tree", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Tree", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -417,15 +458,20 @@ }, { "name" : "getNodeById", + "type" : "function", "desc" : "Gets a node in this tree by its id.", + "sig" : "(id)", + "static" : false, + "memberOf" : "Roo.data.Tree", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.data.Tree", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -444,29 +490,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -497,15 +553,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -530,15 +591,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -551,15 +617,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -572,15 +643,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -605,15 +681,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -638,15 +719,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -665,15 +751,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -698,15 +789,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -739,8 +835,10 @@ "events" : [ { "name" : "dblclick", + "type" : "function", "desc" : "Fires when a node is double clicked", - "memberOf" : "Roo.tree.TreePanel", + "sig" : "function (node, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -763,8 +861,10 @@ }, { "name" : "contextmenu", + "type" : "function", "desc" : "Fires when a node is right clicked", - "memberOf" : "Roo.tree.TreePanel", + "sig" : "function (node, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -787,8 +887,10 @@ }, { "name" : "beforeclick", + "type" : "function", "desc" : "Fires before click processing on a node. Return false to cancel the default action.", - "memberOf" : "Roo.tree.TreePanel", + "sig" : "function (node, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -811,8 +913,10 @@ }, { "name" : "checkchange", + "type" : "function", "desc" : "Fires when a node with a checkbox's checked property changes", - "memberOf" : "Roo.tree.TreePanel", + "sig" : "function (_self, checked)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -835,8 +939,10 @@ }, { "name" : "nodedragover", + "type" : "function", "desc" : "Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. The dragOverEvent\npassed to handlers has the following properties:
    \n
      \n
    • tree - The TreePanel
    • \n
    • target - The node being targeted for the drop
    • \n
    • data - The drag data from the drag source
    • \n
    • point - The point of the drop - append, above or below
    • \n
    • source - The drag source
    • \n
    • rawEvent - Raw mouse event
    • \n
    • dropNode - Drop node(s) provided by the source.
    • \n
    • cancel - Set this to true to signal drop not allowed.
    • \n
    ", - "memberOf" : "Roo.tree.TreePanel", + "sig" : "function (dragOverEvent)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -853,8 +959,10 @@ }, { "name" : "beforeexpand", + "type" : "function", "desc" : "Fires before a node is expanded, return false to cancel.", - "memberOf" : "Roo.tree.TreePanel", + "sig" : "function (node, deep, anim)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -883,8 +991,10 @@ }, { "name" : "collapse", + "type" : "function", "desc" : "Fires when a node is collapsed", - "memberOf" : "Roo.tree.TreePanel", + "sig" : "function (node)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -901,8 +1011,10 @@ }, { "name" : "beforenodedrop", + "type" : "function", "desc" : "Fires when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The dropEvent\npassed to handlers has the following properties:
    \n
      \n
    • tree - The TreePanel
    • \n
    • target - The node being targeted for the drop
    • \n
    • data - The drag data from the drag source
    • \n
    • point - The point of the drop - append, above or below
    • \n
    • source - The drag source
    • \n
    • rawEvent - Raw mouse event
    • \n
    • dropNode - Drop node(s) provided by the source OR you can supply node(s)\nto be inserted by setting them on this object.
    • \n
    • cancel - Set this to true to cancel the drop.
    • \n
    ", - "memberOf" : "Roo.tree.TreePanel", + "sig" : "function (dropEvent)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -919,8 +1031,10 @@ }, { "name" : "beforechildrenrendered", + "type" : "function", "desc" : "Fires right before the child nodes for a node are rendered", - "memberOf" : "Roo.tree.TreePanel", + "sig" : "function (node)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -937,8 +1051,10 @@ }, { "name" : "textchange", + "type" : "function", "desc" : "Fires when the text for a node is changed", - "memberOf" : "Roo.tree.TreePanel", + "sig" : "function (node, text, oldText)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -967,8 +1083,10 @@ }, { "name" : "load", + "type" : "function", "desc" : "Fires when a node is loaded", - "memberOf" : "Roo.tree.TreePanel", + "sig" : "function (node)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -985,8 +1103,10 @@ }, { "name" : "appendnode", + "type" : "function", "desc" : "Fires when append node to the tree", - "memberOf" : "Roo.tree.TreePanel", + "sig" : "function (_self, node, index)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1015,8 +1135,10 @@ }, { "name" : "startdrag", + "type" : "function", "desc" : "Fires when a node starts being dragged", - "memberOf" : "Roo.tree.TreePanel", + "sig" : "function (_self, node, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1045,8 +1167,10 @@ }, { "name" : "click", + "type" : "function", "desc" : "Fires when a node is clicked", - "memberOf" : "Roo.tree.TreePanel", + "sig" : "function (node, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1069,8 +1193,10 @@ }, { "name" : "expand", + "type" : "function", "desc" : "Fires when a node is expanded", - "memberOf" : "Roo.tree.TreePanel", + "sig" : "function (node)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1087,8 +1213,10 @@ }, { "name" : "enddrag", + "type" : "function", "desc" : "Fires when a drag operation is complete", - "memberOf" : "Roo.tree.TreePanel", + "sig" : "function (_self, node, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1117,8 +1245,10 @@ }, { "name" : "nodedrop", + "type" : "function", "desc" : "Fires after a DD object is dropped on a node in this tree. The dropEvent\npassed to handlers has the following properties:
    \n
      \n
    • tree - The TreePanel
    • \n
    • target - The node being targeted for the drop
    • \n
    • data - The drag data from the drag source
    • \n
    • point - The point of the drop - append, above or below
    • \n
    • source - The drag source
    • \n
    • rawEvent - Raw mouse event
    • \n
    • dropNode - Dropped node(s).
    • \n
    ", - "memberOf" : "Roo.tree.TreePanel", + "sig" : "function (dropEvent)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1135,8 +1265,10 @@ }, { "name" : "dragdrop", + "type" : "function", "desc" : "Fires when a dragged node is dropped on a valid DD target", - "memberOf" : "Roo.tree.TreePanel", + "sig" : "function (_self, node, dd, e)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1171,8 +1303,10 @@ }, { "name" : "beforecollapse", + "type" : "function", "desc" : "Fires before a node is collapsed, return false to cancel.", - "memberOf" : "Roo.tree.TreePanel", + "sig" : "function (node, deep, anim)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1201,8 +1335,10 @@ }, { "name" : "disabledchange", + "type" : "function", "desc" : "Fires when the disabled status of a node changes", - "memberOf" : "Roo.tree.TreePanel", + "sig" : "function (node, disabled)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1225,8 +1361,10 @@ }, { "name" : "beforeload", + "type" : "function", "desc" : "Fires before a node is loaded, return false to cancel", - "memberOf" : "Roo.tree.TreePanel", + "sig" : "function (node)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1243,7 +1381,9 @@ }, { "name" : "append", + "type" : "function", "desc" : "Fires when a new child node is appended to a node in this tree.", + "sig" : "function (tree, parent, node, index)\n{\n\n}", "memberOf" : "Roo.data.Tree", "example" : "", "deprecated" : "", @@ -1279,7 +1419,9 @@ }, { "name" : "beforemove", + "type" : "function", "desc" : "Fires before a node is moved to a new location in the tree. Return false to cancel the move.", + "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}", "memberOf" : "Roo.data.Tree", "example" : "", "deprecated" : "", @@ -1321,7 +1463,9 @@ }, { "name" : "insert", + "type" : "function", "desc" : "Fires when a new child node is inserted in a node in this tree.", + "sig" : "function (tree, parent, node, refNode)\n{\n\n}", "memberOf" : "Roo.data.Tree", "example" : "", "deprecated" : "", @@ -1357,7 +1501,9 @@ }, { "name" : "beforeappend", + "type" : "function", "desc" : "Fires before a new child is appended to a node in this tree, return false to cancel the append.", + "sig" : "function (tree, parent, node)\n{\n\n}", "memberOf" : "Roo.data.Tree", "example" : "", "deprecated" : "", @@ -1387,7 +1533,9 @@ }, { "name" : "move", + "type" : "function", "desc" : "Fires when a node is moved to a new location in the tree", + "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}", "memberOf" : "Roo.data.Tree", "example" : "", "deprecated" : "", @@ -1429,7 +1577,9 @@ }, { "name" : "beforeremove", + "type" : "function", "desc" : "Fires before a child is removed from a node in this tree, return false to cancel the remove.", + "sig" : "function (tree, parent, node)\n{\n\n}", "memberOf" : "Roo.data.Tree", "example" : "", "deprecated" : "", @@ -1459,7 +1609,9 @@ }, { "name" : "remove", + "type" : "function", "desc" : "Fires when a child node is removed from a node in this tree.", + "sig" : "function (tree, parent, node)\n{\n\n}", "memberOf" : "Roo.data.Tree", "example" : "", "deprecated" : "", @@ -1489,7 +1641,9 @@ }, { "name" : "beforeinsert", + "type" : "function", "desc" : "Fires before a new child is inserted in a node in this tree, return false to cancel the insert.", + "sig" : "function (tree, parent, node, refNode)\n{\n\n}", "memberOf" : "Roo.data.Tree", "example" : "", "deprecated" : "", diff --git a/docs/symbols/Roo.tree.TreeSorter.json b/docs/symbols/Roo.tree.TreeSorter.json index cf49bbf8ca..6d57071f4c 100644 --- a/docs/symbols/Roo.tree.TreeSorter.json +++ b/docs/symbols/Roo.tree.TreeSorter.json @@ -25,48 +25,44 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "folderSort", "type" : "Boolean", "desc" : "True to sort leaf nodes under non leaf nodes", - "memberOf" : "Roo.tree.TreeSorter", - "optvals" : [] + "memberOf" : "" }, { "name" : "leafAttr", "type" : "String", "desc" : "The attribute used to determine leaf nodes in folder sort (defaults to \"leaf\")", - "memberOf" : "Roo.tree.TreeSorter", - "optvals" : [] + "memberOf" : "" }, { "name" : "caseSensitive", "type" : "Boolean", "desc" : "true for case sensitive sort (defaults to false)", - "memberOf" : "Roo.tree.TreeSorter", - "optvals" : [] + "memberOf" : "" }, { "name" : "dir", "type" : "String", "desc" : "The direction to sort (asc or desc) (defaults to asc)", - "memberOf" : "Roo.tree.TreeSorter", - "optvals" : [] + "memberOf" : "" }, { "name" : "sortType", "type" : "Function", "desc" : "A custom \"casting\" function used to convert node values before sorting", - "memberOf" : "Roo.tree.TreeSorter", - "optvals" : [] + "memberOf" : "" }, { "name" : "property", "type" : "String", "desc" : "The named attribute on the node to sort by (defaults to text)", - "memberOf" : "Roo.tree.TreeSorter", - "optvals" : [] + "memberOf" : "" } ], "methods" : [], diff --git a/docs/symbols/Roo.tree.json b/docs/symbols/Roo.tree.json index c06e09b89d..d51cef0954 100644 --- a/docs/symbols/Roo.tree.json +++ b/docs/symbols/Roo.tree.json @@ -12,6 +12,8 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.util.CSS.json b/docs/symbols/Roo.util.CSS.json index 9af8f1ded4..e9fbd5f083 100644 --- a/docs/symbols/Roo.util.CSS.json +++ b/docs/symbols/Roo.util.CSS.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "createStyleSheet", + "type" : "function", "desc" : "Very simple dynamic creation of stylesheets from a text blob of rules. The text will wrapped in a style\ntag and appended to the HEAD of the document.", + "sig" : "(cssText, id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.CSS", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "cssText", @@ -49,15 +56,20 @@ }, { "name" : "getRules", + "type" : "function", "desc" : "Gets all css rules for the document", + "sig" : "(refreshCache)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.CSS", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "refreshCache", @@ -76,15 +88,20 @@ }, { "name" : "swapStyleSheet", + "type" : "function", "desc" : "Dynamically swaps an existing stylesheet reference for a new one", + "sig" : "(id, url)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.CSS", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -103,15 +120,20 @@ }, { "name" : "updateRule", + "type" : "function", "desc" : "Updates a rule property", + "sig" : "(selector, property, value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.CSS", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -142,15 +164,20 @@ }, { "name" : "getRule", + "type" : "function", "desc" : "Gets an an individual CSS rule by selector(s)", + "sig" : "(selector, refreshCache)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.CSS", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selector", @@ -175,15 +202,20 @@ }, { "name" : "refreshCache", + "type" : "function", "desc" : "Refresh the rule cache if you have dynamically added stylesheets", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.CSS", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -195,15 +227,20 @@ }, { "name" : "removeStyleSheet", + "type" : "function", "desc" : "Removes a style or link tag by id", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.CSS", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", diff --git a/docs/symbols/Roo.util.ClickRepeater.json b/docs/symbols/Roo.util.ClickRepeater.json index d4bbe460e2..1a2bcde3d8 100644 --- a/docs/symbols/Roo.util.ClickRepeater.json +++ b/docs/symbols/Roo.util.ClickRepeater.json @@ -27,90 +27,94 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "stopDefault", "type" : "Boolean", "desc" : "True to stop the default click event", - "memberOf" : "Roo.util.ClickRepeater", - "optvals" : [] + "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "delay", "type" : "Number", "desc" : "The initial delay before the repeating event begins firing.\nSimilar to an autorepeat key delay.", - "memberOf" : "Roo.util.ClickRepeater", - "optvals" : [] + "memberOf" : "" }, { "name" : "accelerate", "type" : "Boolean", "desc" : "True if autorepeating should start slowly and accelerate.\n \"interval\" and \"delay\" are ignored. \"immediate\" is honored.", - "memberOf" : "Roo.util.ClickRepeater", - "optvals" : [] + "memberOf" : "" }, { "name" : "preventDefault", "type" : "Boolean", "desc" : "True to prevent the default click event", - "memberOf" : "Roo.util.ClickRepeater", - "optvals" : [] + "memberOf" : "" }, { "name" : "interval", "type" : "Number", "desc" : "The interval between firings of the \"click\" event. Default 10 ms.", - "memberOf" : "Roo.util.ClickRepeater", - "optvals" : [] + "memberOf" : "" }, { "name" : "el", "type" : "String/HTMLElement/Element", "desc" : "The element to act as a button.", - "memberOf" : "Roo.util.ClickRepeater", - "optvals" : [] + "memberOf" : "" }, { "name" : "pressClass", "type" : "String", "desc" : "A CSS class name to be applied to the element while pressed.", - "memberOf" : "Roo.util.ClickRepeater", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -141,15 +145,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -174,15 +183,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -195,15 +209,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -216,15 +235,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -249,15 +273,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -282,15 +311,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -309,15 +343,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -342,15 +381,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -383,8 +427,10 @@ "events" : [ { "name" : "mousedown", + "type" : "function", "desc" : "Fires when the mouse button is depressed.", - "memberOf" : "Roo.util.ClickRepeater", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -401,8 +447,10 @@ }, { "name" : "click", + "type" : "function", "desc" : "Fires on a specified interval during the time the element is pressed.", - "memberOf" : "Roo.util.ClickRepeater", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -419,8 +467,10 @@ }, { "name" : "mouseup", + "type" : "function", "desc" : "Fires when the mouse key is released.", - "memberOf" : "Roo.util.ClickRepeater", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.util.Clipboard.json b/docs/symbols/Roo.util.Clipboard.json index 43df528217..b668665656 100644 --- a/docs/symbols/Roo.util.Clipboard.json +++ b/docs/symbols/Roo.util.Clipboard.json @@ -12,6 +12,8 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.util.DelayedTask.json b/docs/symbols/Roo.util.DelayedTask.json index 9d0d9e7478..df70f2152f 100644 --- a/docs/symbols/Roo.util.DelayedTask.json +++ b/docs/symbols/Roo.util.DelayedTask.json @@ -31,6 +31,8 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.util.Format.json b/docs/symbols/Roo.util.Format.json index 2e053ffd65..36a7761327 100644 --- a/docs/symbols/Roo.util.Format.json +++ b/docs/symbols/Roo.util.Format.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "uppercase", + "type" : "function", "desc" : "Converts a string to all upper case letters", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Format", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -43,15 +50,20 @@ }, { "name" : "date", + "type" : "function", "desc" : "Parse a value into a formatted date using the specified format pattern.", + "sig" : "(value, format)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Format", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -76,15 +88,20 @@ }, { "name" : "lowercase", + "type" : "function", "desc" : "Converts a string to all lower case letters", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Format", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -103,15 +120,20 @@ }, { "name" : "undef", + "type" : "function", "desc" : "Checks a reference and converts it to empty string if it is undefined", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Format", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -130,15 +152,20 @@ }, { "name" : "stripTags", + "type" : "function", "desc" : "Strips all HTML tags", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Format", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -157,15 +184,20 @@ }, { "name" : "ellipsis", + "type" : "function", "desc" : "Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length", + "sig" : "(value, length)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Format", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -190,15 +222,20 @@ }, { "name" : "htmlDecode", + "type" : "function", "desc" : "Convert certain characters (&, <, >, and ') from their HTML character equivalents.", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Format", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -217,15 +254,20 @@ }, { "name" : "htmlEncode", + "type" : "function", "desc" : "Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages.", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Format", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -244,15 +286,20 @@ }, { "name" : "size", + "type" : "function", "desc" : "Size in Mb,Gb etc.", + "sig" : "(value, decimals)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Format", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -277,15 +324,20 @@ }, { "name" : "toFixed", + "type" : "function", "desc" : "safer version of Math.toFixed..??/", + "sig" : "(value, value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Format", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -310,15 +362,20 @@ }, { "name" : "substr", + "type" : "function", "desc" : "Returns a substring from within an original string", + "sig" : "(value, start, length)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Format", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -349,15 +406,20 @@ }, { "name" : "number", + "type" : "function", "desc" : "Format a number\neventually this should probably emulate php's number_format", + "sig" : "(value, decimals, delimiter)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Format", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -388,15 +450,20 @@ }, { "name" : "usMoney", + "type" : "function", "desc" : "Format a number as US currency", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Format", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -415,15 +482,20 @@ }, { "name" : "capitalize", + "type" : "function", "desc" : "Converts the first character only of a string to upper case", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Format", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -442,15 +514,20 @@ }, { "name" : "trim", + "type" : "function", "desc" : "Trims any whitespace from either side of a string", + "sig" : "(value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Format", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -469,15 +546,20 @@ }, { "name" : "dateRenderer", + "type" : "function", "desc" : "Returns a date rendering function that can be reused to apply a date format multiple times efficiently", + "sig" : "(format)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Format", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "format", diff --git a/docs/symbols/Roo.util.JSON.json b/docs/symbols/Roo.util.JSON.json index 38e4f4dad2..a33614ef3c 100644 --- a/docs/symbols/Roo.util.JSON.json +++ b/docs/symbols/Roo.util.JSON.json @@ -12,6 +12,8 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.util.MixedCollection.json b/docs/symbols/Roo.util.MixedCollection.json index e0134762cf..61331e488d 100644 --- a/docs/symbols/Roo.util.MixedCollection.json +++ b/docs/symbols/Roo.util.MixedCollection.json @@ -27,27 +27,33 @@ } ], "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" } ], "methods" : [ { "name" : "remove", + "type" : "function", "desc" : "Removed an item from the collection.", + "sig" : "(o)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -66,15 +72,20 @@ }, { "name" : "get", + "type" : "function", "desc" : "Returns the item associated with the passed key or index.", + "sig" : "(key)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "key", @@ -93,15 +104,20 @@ }, { "name" : "itemAt", + "type" : "function", "desc" : "Returns the item at the specified index.", + "sig" : "(index)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -120,15 +136,20 @@ }, { "name" : "each", + "type" : "function", "desc" : "Executes the specified function once for every item in the collection, passing each\nitem as the first and only parameter. returning false from the function will stop the iteration.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -147,15 +168,20 @@ }, { "name" : "insert", + "type" : "function", "desc" : "Inserts an item at the specified index in the collection.", + "sig" : "(index, key, o)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -186,15 +212,20 @@ }, { "name" : "getCount", + "type" : "function", "desc" : "Returns the number of items in the collection.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -206,29 +237,39 @@ }, { "name" : "clear", + "type" : "function", "desc" : "Removes all items from the collection.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "keySort", + "type" : "function", "desc" : "Sorts this collection by keys", + "sig" : "(direction, fn)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "direction", @@ -247,15 +288,20 @@ }, { "name" : "indexOf", + "type" : "function", "desc" : "Returns index within the collection of the passed Object.", + "sig" : "(o)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -274,15 +320,20 @@ }, { "name" : "clone", + "type" : "function", "desc" : "Creates a duplicate of this collection", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -294,15 +345,20 @@ }, { "name" : "containsKey", + "type" : "function", "desc" : "Returns true if the collection contains the passed Object as a key.", + "sig" : "(key)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "key", @@ -321,15 +377,20 @@ }, { "name" : "getKey", + "type" : "function", "desc" : "MixedCollection has a generic way to fetch keys if you implement getKey.\n
    \n// normal way\nvar mc = new Roo.util.MixedCollection();\nmc.add(someEl.dom.id, someEl);\nmc.add(otherEl.dom.id, otherEl);\n//and so on\n\n// using getKey\nvar mc = new Roo.util.MixedCollection();\nmc.getKey = function(el){\n   return el.dom.id;\n};\nmc.add(someEl);\nmc.add(otherEl);\n\n// or via the constructor\nvar mc = new Roo.util.MixedCollection(false, function(el){\n   return el.dom.id;\n});\nmc.add(someEl);\nmc.add(otherEl);\n
    ", + "sig" : "(o)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -348,15 +409,20 @@ }, { "name" : "find", + "type" : "function", "desc" : "Returns the first item in the collection which elicits a true return value from the\npassed selection function.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -381,15 +447,20 @@ }, { "name" : "getRange", + "type" : "function", "desc" : "Returns a range of items in this collection", + "sig" : "(startIndex, endIndex)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "startIndex", @@ -414,15 +485,20 @@ }, { "name" : "eachKey", + "type" : "function", "desc" : "Executes the specified function once for every key in the collection, passing each\nkey, and its associated item as the first two parameters.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -441,15 +517,20 @@ }, { "name" : "indexOfKey", + "type" : "function", "desc" : "Returns index within the collection of the passed key.", + "sig" : "(key)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "key", @@ -468,15 +549,20 @@ }, { "name" : "contains", + "type" : "function", "desc" : "Returns true if the collection contains the passed Object as an item.", + "sig" : "(o)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -495,15 +581,20 @@ }, { "name" : "addAll", + "type" : "function", "desc" : "Adds all elements of an Array or an Object to the collection.", + "sig" : "(objs)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "objs", @@ -516,15 +607,20 @@ }, { "name" : "key", + "type" : "function", "desc" : "Returns the item associated with the passed key.", + "sig" : "(key)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "key", @@ -543,15 +639,20 @@ }, { "name" : "item", + "type" : "function", "desc" : "Returns the item associated with the passed key OR index. Key has priority over index.", + "sig" : "(key)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "key", @@ -570,15 +671,20 @@ }, { "name" : "filterBy", + "type" : "function", "desc" : "Filter by a function. * Returns a new collection that has been filtered.\nThe passed function will be called with each \nobject in the collection. If the function returns true, the value is included \notherwise it is filtered.", + "sig" : "(fn, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "fn", @@ -603,15 +709,20 @@ }, { "name" : "add", + "type" : "function", "desc" : "Adds an item to the collection.", + "sig" : "(key, o)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "key", @@ -636,15 +747,20 @@ }, { "name" : "removeAt", + "type" : "function", "desc" : "Remove an item from a specified index in the collection.", + "sig" : "(index)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "index", @@ -657,15 +773,20 @@ }, { "name" : "removeKey", + "type" : "function", "desc" : "Removed an item associated with the passed key fom the collection.", + "sig" : "(key)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "key", @@ -678,15 +799,20 @@ }, { "name" : "filter", + "type" : "function", "desc" : "Filter the objects in this collection by a specific property. \nReturns a new collection that has been filtered.", + "sig" : "(property, value)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "property", @@ -711,15 +837,20 @@ }, { "name" : "last", + "type" : "function", "desc" : "Returns the last item in the collection.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -731,15 +862,20 @@ }, { "name" : "replace", + "type" : "function", "desc" : "Replaces an item in the collection.", + "sig" : "(key, o)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "key", @@ -764,15 +900,20 @@ }, { "name" : "first", + "type" : "function", "desc" : "Returns the first item in the collection.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -784,15 +925,20 @@ }, { "name" : "sort", + "type" : "function", "desc" : "Sorts this collection with the passed comparison function", + "sig" : "(direction, fn)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.MixedCollection", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "direction", @@ -811,29 +957,39 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -864,15 +1020,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -897,15 +1058,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -918,15 +1084,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -939,15 +1110,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -972,15 +1148,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1005,15 +1186,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1032,15 +1218,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -1065,15 +1256,20 @@ }, { "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, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -1106,8 +1302,10 @@ "events" : [ { "name" : "remove", + "type" : "function", "desc" : "Fires when an item is removed from the collection.", - "memberOf" : "Roo.util.MixedCollection", + "sig" : "function (o, key)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1130,8 +1328,10 @@ }, { "name" : "add", + "type" : "function", "desc" : "Fires when an item is added to the collection.", - "memberOf" : "Roo.util.MixedCollection", + "sig" : "function (index, o, key)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1160,8 +1360,10 @@ }, { "name" : "replace", + "type" : "function", "desc" : "Fires when an item is replaced in the collection.", - "memberOf" : "Roo.util.MixedCollection", + "sig" : "function (key, old, new)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -1190,8 +1392,10 @@ }, { "name" : "clear", + "type" : "function", "desc" : "Fires when the collection is cleared.", - "memberOf" : "Roo.util.MixedCollection", + "sig" : "function ()\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", diff --git a/docs/symbols/Roo.util.Observable.json b/docs/symbols/Roo.util.Observable.json index d3a57bdf4d..1ac8af6700 100644 --- a/docs/symbols/Roo.util.Observable.json +++ b/docs/symbols/Roo.util.Observable.json @@ -19,41 +19,52 @@ } ], "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", - "optvals" : [] + "memberOf" : "" } ], "methods" : [ { "name" : "purgeListeners", + "type" : "function", "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "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" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -84,15 +95,20 @@ }, { "name" : "un", + "type" : "function", "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -117,15 +133,20 @@ }, { "name" : "addEvents", + "type" : "function", "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -138,15 +159,20 @@ }, { "name" : "releaseCapture", + "type" : "function", "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -159,15 +185,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -192,15 +223,20 @@ }, { "name" : "fireEvent", + "type" : "function", "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -225,15 +261,20 @@ }, { "name" : "hasListener", + "type" : "function", "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -252,15 +293,20 @@ }, { "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" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -285,15 +331,20 @@ }, { "name" : "addListener", + "type" : "function", "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", diff --git a/docs/symbols/Roo.util.TextMetrics.Instance.json b/docs/symbols/Roo.util.TextMetrics.Instance.json index 5130a0f073..91e74fadfd 100644 --- a/docs/symbols/Roo.util.TextMetrics.Instance.json +++ b/docs/symbols/Roo.util.TextMetrics.Instance.json @@ -12,6 +12,8 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/Roo.util.TextMetrics.json b/docs/symbols/Roo.util.TextMetrics.json index 4f7da00bcf..78eb2ea77b 100644 --- a/docs/symbols/Roo.util.TextMetrics.json +++ b/docs/symbols/Roo.util.TextMetrics.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "createInstance", + "type" : "function", "desc" : "Return a unique TextMetrics instance that can be bound directly to an element and reused. This reduces\nthe overhead of multiple calls to initialize the style properties on each measurement.", + "sig" : "(el, fixedWidth)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.TextMetrics", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -49,15 +56,20 @@ }, { "name" : "measure", + "type" : "function", "desc" : "Measures the size of the specified text", + "sig" : "(el, text, fixedWidth)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.TextMetrics", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", diff --git a/docs/symbols/Roo.util.json b/docs/symbols/Roo.util.json index efb7b6caab..bdd2954a01 100644 --- a/docs/symbols/Roo.util.json +++ b/docs/symbols/Roo.util.json @@ -12,6 +12,8 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/symbols/String.json b/docs/symbols/String.json index dffcd9893c..5faad48fa5 100644 --- a/docs/symbols/String.json +++ b/docs/symbols/String.json @@ -12,19 +12,26 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "escape", + "type" : "function", "desc" : "Escapes the passed string for ' and \\", + "sig" : "(string)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "String", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "string", @@ -43,15 +50,20 @@ }, { "name" : "leftPad", + "type" : "function", "desc" : "Pads the left side of a string with a specified character. This is especially useful\nfor normalizing number and date strings. Example usage:\n
    \nvar s = String.leftPad('123', 5, '0');\n// s now contains the string: '00123'\n
    ", + "sig" : "(string, size, char)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "String", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "string", @@ -82,15 +94,20 @@ }, { "name" : "toggle", + "type" : "function", "desc" : "Utility function that allows you to easily switch a string between two alternating values. The passed value\nis compared to the current string, and if they are equal, the other value that was passed in is returned. If\nthey are already different, the first value passed in is returned. Note that this method returns the new value\nbut does not change the current string.\n
    \n// alternate sort directions\nsort = sort.toggle('ASC', 'DESC');\n\n// instead of conditional logic:\nsort = (sort == 'ASC' ? 'DESC' : 'ASC');\n
    ", + "sig" : "(value, other)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "String", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -115,15 +132,20 @@ }, { "name" : "format", + "type" : "function", "desc" : "Allows you to define a tokenized string and pass an arbitrary number of arguments to replace the tokens. Each\ntoken must be unique, and must increment in the format {0}, {1}, etc. Example usage:\n
    \nvar cls = 'my-class', text = 'Some text';\nvar s = String.format('
    {1}
    ', cls, text);\n// s now contains the string: '
    Some text
    '\n
    ", + "sig" : "(string, value1, value2)", + "static" : true, + "memberOf" : "", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "String", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "string", @@ -154,15 +176,20 @@ }, { "name" : "unicodeClean", + "type" : "function", "desc" : "Remove invalid unicode characters from a string", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "String", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { diff --git a/docs/symbols/_global_.json b/docs/symbols/_global_.json index 64f300291d..2281e1c5f3 100644 --- a/docs/symbols/_global_.json +++ b/docs/symbols/_global_.json @@ -12,117 +12,159 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [ { "name" : "escape", + "type" : "function", "desc" : "Helpers", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "_global_", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "merge", + "type" : "function", "desc" : "eval:var:merge", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "_global_", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "Renderer", + "type" : "function", "desc" : "eval:var:Renderer", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "_global_", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "InlineLexer", + "type" : "function", "desc" : "Inline Lexer & Compiler", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "_global_", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "marked", + "type" : "function", "desc" : "eval:var:marked", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "_global_", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "noop", + "type" : "function", "desc" : "eval:var:noop", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "_global_", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "Lexer", + "type" : "function", "desc" : "Block Lexer", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "_global_", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "Parser", + "type" : "function", "desc" : "eval:var:Parser", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "_global_", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] } diff --git a/docs/symbols/this.json b/docs/symbols/this.json index d7eda834a0..4316043b96 100644 --- a/docs/symbols/this.json +++ b/docs/symbols/this.json @@ -12,6 +12,8 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "config" : [], "methods" : [], "events" : [] diff --git a/docs/tree.json b/docs/tree.json index 2ec03bbf4f..b7e67845ca 100644 --- a/docs/tree.json +++ b/docs/tree.json @@ -1251,7 +1251,7 @@ { "name" : "Roo.grid.AbstractGridView", "cn" : [], - "is_class" : false + "is_class" : true }, { "name" : "Roo.grid.AbstractSelectionModel", -- 2.39.2