"props": [],
"events": []
},
- "El": {
- "props": [],
- "events": []
- },
"Function": {
"props": [],
"events": []
"props": [],
"events": []
},
- "Roo": {
- "props": [],
- "events": []
- },
"Roo.Ajax": {
"props": [],
- "events": []
+ "events": [
+ {
+ "name": "beforerequest",
+ "sig": "function (conn, options)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a network request is made to retrieve a data object."
+ },
+ {
+ "name": "requestcomplete",
+ "sig": "function (conn, response, options)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires if the request was successfully completed."
+ },
+ {
+ "name": "requestexception",
+ "sig": "function (conn, response, options)\n{\n\n}",
+ "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."
+ }
+ ]
},
"Roo.BasicDialog": {
"props": [
"type": "Boolean",
"desc": "True to create an iframe shim that prevents selects from showing through (defaults to false)",
"memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
"events": [
]
},
"Roo.BasicLayoutRegion": {
- "props": [],
+ "props": [
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
"events": [
{
"name": "beforeremove",
]
},
"Roo.BorderLayout": {
- "props": [],
- "events": []
+ "props": [
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "layout",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a layout is performed."
+ },
+ {
+ "name": "regioncollapsed",
+ "sig": "function (region)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a region is collapsed."
+ },
+ {
+ "name": "regionexpanded",
+ "sig": "function (region)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a region is expanded."
+ },
+ {
+ "name": "regionresized",
+ "sig": "function (region, newSize)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the user resizes a region."
+ }
+ ]
},
"Roo.BoxComponent": {
"props": [
"type": "Number",
"desc": "height (optional) size of component",
"memberOf": ""
+ },
+ {
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
"events": [
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
{
"name": "move",
"sig": "function (_self, x, y)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is moved."
},
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
{
"name": "resize",
"sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is resized."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
}
]
},
"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": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
"events": [
"type": "Boolean",
"desc": "If set to true then reselecting a color that is already selected fires the selection event",
"memberOf": ""
+ },
+ {
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
"events": [
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
{
"name": "select",
"sig": "function (_self, color)\n{\n\n}",
"type": "function",
"desc": "Fires when a color is selected"
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
}
]
},
"type": "String",
"desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
"memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
"events": [
"memberOf": ""
},
{
- "name": "params",
+ "name": "region",
+ "type": "String",
+ "desc": "(center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
+ "memberOf": ""
+ },
+ {
+ "name": "params",
"type": "String/Object",
"desc": "When used with {@link #url}, calls {@link #setUrl} with this value",
"memberOf": ""
"type": "Boolean",
"desc": "When used with {@link #url}, calls {@link #setUrl} with this value",
"memberOf": ""
+ },
+ {
+ "name": "content",
+ "type": "String",
+ "desc": "Raw content to fill content panel with (uses setContent on construction.)",
+ "memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
"events": [
"type": "function",
"desc": "Fires when this panel is activated."
},
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this tab is created"
+ },
{
"name": "resize",
"sig": "function (_self, width, height)\n{\n\n}",
"type": "Bool",
"desc": "Show a clear button (usefull for date form elements that can be blank.)",
"memberOf": ""
+ },
+ {
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
"events": [
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "monthchange",
+ "sig": "function (_self, date)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the displayed month changes"
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
{
"name": "select",
"sig": "function (_self, date)\n{\n\n}",
"type": "function",
"desc": "Fires when a date is selected"
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
}
]
},
"type": "Boolean",
"desc": "True to update the innerHTML of the bound element when the update completes (defaults to false)",
"memberOf": ""
+ },
+ {
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
"events": [
"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."
},
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
{
"name": "beforestartedit",
"sig": "function (_self, boundEl, value)\n{\n\n}",
"type": "function",
"desc": "Fires after editing is complete and any changed value has been written to the underlying field."
},
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ },
{
"name": "specialkey",
"sig": "function (_self, e)\n{\n\n}",
"events": []
},
"Roo.GridPanel": {
- "props": [],
- "events": []
- },
- "Roo.JsonView": {
- "props": [],
- "events": [
- {
- "name": "beforerender",
- "sig": "function (_self, data)\n{\n\n}",
- "type": "function",
- "desc": "Fires before rendering of the downloaded JSON data."
- },
+ "props": [
{
- "name": "load",
- "sig": "function (_self, data, response)\n{\n\n}",
- "type": "function",
- "desc": "Fires when data is loaded."
+ "name": "fitToFrame",
+ "type": "Boolean",
+ "desc": "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
+ "memberOf": "Roo.ContentPanel"
},
{
- "name": "loadexception",
- "sig": "function (_self, response)\n{\n\n}",
- "type": "function",
- "desc": "Fires when loading fails."
- }
- ]
- },
- "Roo.KeyMap": {
- "props": [],
- "events": []
- },
- "Roo.KeyNav": {
- "props": [
- {
- "name": "disabled",
+ "name": "fitContainer",
"type": "Boolean",
- "desc": "True to disable this KeyNav instance (defaults to false)",
- "memberOf": ""
+ "desc": "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
+ "memberOf": "Roo.ContentPanel"
},
{
- "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": ""
+ "name": "autoCreate",
+ "type": "Boolean/Object",
+ "desc": "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
+ "memberOf": "Roo.ContentPanel"
},
{
- "name": "forceKeyDown",
+ "name": "closable",
"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": ""
- }
- ],
- "events": []
- },
- "Roo.Layer": {
- "props": [
+ "desc": "True if the panel can be closed/removed",
+ "memberOf": "Roo.ContentPanel"
+ },
{
- "name": "shim",
+ "name": "background",
"type": "Boolean",
- "desc": "False to disable the iframe shim in browsers which need one (defaults to true)",
- "memberOf": ""
+ "desc": "True if the panel should not be activated when it is added (defaults to false)",
+ "memberOf": "Roo.ContentPanel"
},
{
- "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": ""
+ "name": "resizeEl",
+ "type": "String/HTMLElement/Element",
+ "desc": "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
+ "memberOf": "Roo.ContentPanel"
},
{
- "name": "dh",
- "type": "Object",
- "desc": "DomHelper object config to create element with (defaults to {tag: \"div\", cls: \"x-layer\"}).",
- "memberOf": ""
+ "name": "toolbar",
+ "type": "Toolbar",
+ "desc": "A toolbar for this panel",
+ "memberOf": "Roo.ContentPanel"
},
{
- "name": "constrain",
+ "name": "autoScroll",
"type": "Boolean",
- "desc": "False to disable constrain to viewport (defaults to true)",
- "memberOf": ""
+ "desc": "True to scroll overflow in this panel (use with {@link #fitToFrame})",
+ "memberOf": "Roo.ContentPanel"
},
{
- "name": "cls",
+ "name": "title",
"type": "String",
- "desc": "CSS class to add to the element",
- "memberOf": ""
+ "desc": "The title for this panel",
+ "memberOf": "Roo.ContentPanel"
},
{
- "name": "zindex",
- "type": "Number",
- "desc": "Starting z-index (defaults to 11000)",
- "memberOf": ""
+ "name": "adjustments",
+ "type": "Array",
+ "desc": "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
+ "memberOf": "Roo.ContentPanel"
},
{
- "name": "shadowOffset",
- "type": "Number",
- "desc": "Number of pixels to offset the shadow (defaults to 3)",
- "memberOf": ""
+ "name": "url",
+ "type": "String",
+ "desc": "Calls {@link #setUrl} with this value",
+ "memberOf": "Roo.ContentPanel"
+ },
+ {
+ "name": "region",
+ "type": "String",
+ "desc": "(center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
+ "memberOf": "Roo.ContentPanel"
+ },
+ {
+ "name": "params",
+ "type": "String/Object",
+ "desc": "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf": "Roo.ContentPanel"
+ },
+ {
+ "name": "loadOnce",
+ "type": "Boolean",
+ "desc": "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf": "Roo.ContentPanel"
+ },
+ {
+ "name": "content",
+ "type": "String",
+ "desc": "Raw content to fill content panel with (uses setContent on construction.)",
+ "memberOf": "Roo.ContentPanel"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
- "events": []
- },
- "Roo.LayoutDialog": {
- "props": [],
- "events": []
- },
- "Roo.LayoutManager": {
- "props": [],
"events": [
{
- "name": "layout",
+ "name": "activate",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a layout is performed."
+ "desc": "Fires when this panel is activated."
},
{
- "name": "regioncollapsed",
- "sig": "function (region)\n{\n\n}",
+ "name": "deactivate",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a region is collapsed."
+ "desc": "Fires when this panel is activated."
},
{
- "name": "regionexpanded",
- "sig": "function (region)\n{\n\n}",
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a region is expanded."
+ "desc": "Fires when this tab is created"
},
{
- "name": "regionresized",
- "sig": "function (region, newSize)\n{\n\n}",
+ "name": "resize",
+ "sig": "function (_self, width, height)\n{\n\n}",
"type": "function",
- "desc": "Fires when the user resizes a region."
+ "desc": "Fires when this panel is resized if fitToFrame is true."
}
]
},
- "Roo.LayoutRegion": {
+ "Roo.JsonView": {
"props": [
{
- "name": "collapsible",
+ "name": "store",
+ "type": "Roo.data.Store",
+ "desc": "Data store to load data from.",
+ "memberOf": "Roo.View"
+ },
+ {
+ "name": "el",
+ "type": "String|Roo.Element",
+ "desc": "The container element.",
+ "memberOf": "Roo.View"
+ },
+ {
+ "name": "tpl",
+ "type": "String|Roo.Template",
+ "desc": "The template used by this View",
+ "memberOf": "Roo.View"
+ },
+ {
+ "name": "selectedClass",
+ "type": "String",
+ "desc": "The css class to add to selected nodes",
+ "memberOf": "Roo.View"
+ },
+ {
+ "name": "emptyText",
+ "type": "String",
+ "desc": "The empty text to show when nothing is loaded.",
+ "memberOf": "Roo.View"
+ },
+ {
+ "name": "multiSelect",
"type": "Boolean",
- "desc": "False to disable collapsing (defaults to true)",
- "memberOf": ""
+ "desc": "Allow multiple selection",
+ "memberOf": "Roo.View"
},
{
- "name": "collapsed",
+ "name": "singleSelect",
"type": "Boolean",
- "desc": "True to set the initial display to collapsed (defaults to false)",
- "memberOf": ""
+ "desc": "Allow single selection",
+ "memberOf": "Roo.View"
},
{
- "name": "floatable",
+ "name": "toggleSelect",
"type": "Boolean",
- "desc": "False to disable floating (defaults to true)",
- "memberOf": ""
+ "desc": "- selecting",
+ "memberOf": "Roo.View"
},
{
- "name": "margins",
+ "name": "listeners",
"type": "Object",
- "desc": "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
- "memberOf": ""
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforeclick",
+ "sig": "function (_self, index, node, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a click is processed. Returns false to cancel the default action."
},
{
- "name": "cmargins",
- "type": "Object",
- "desc": "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})",
- "memberOf": ""
+ "name": "beforerender",
+ "sig": "function (_self, data)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before rendering of the downloaded JSON data."
},
{
- "name": "tabPosition",
- "type": "String",
- "desc": "\"top\" or \"bottom\" (defaults to \"bottom\")",
- "memberOf": ""
+ "name": "beforeselect",
+ "sig": "function (_self, node, selections)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a selection is made. If any handlers return false, the selection is cancelled."
},
{
- "name": "collapsedTitle",
- "type": "String",
- "desc": "Optional string message to display in the collapsed block of a north or south region",
- "memberOf": ""
+ "name": "click",
+ "sig": "function (_self, index, node, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a template node is clicked."
},
{
- "name": "alwaysShowTabs",
- "type": "Boolean",
- "desc": "True to always display tabs even when there is only 1 panel (defaults to false)",
- "memberOf": ""
+ "name": "contextmenu",
+ "sig": "function (_self, index, node, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a template node is right clicked."
},
{
- "name": "autoScroll",
- "type": "Boolean",
- "desc": "True to enable overflow scrolling (defaults to false)",
- "memberOf": ""
+ "name": "dblclick",
+ "sig": "function (_self, index, node, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a template node is double clicked."
},
{
- "name": "titlebar",
+ "name": "load",
+ "sig": "function (_self, data, response)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when data is loaded."
+ },
+ {
+ "name": "loadexception",
+ "sig": "function (_self, response)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when loading fails."
+ },
+ {
+ "name": "preparedata",
+ "sig": "function (_self, data)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires on every row to render, to allow you to change the data."
+ },
+ {
+ "name": "selectionchange",
+ "sig": "function (_self, selections)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the selected nodes change."
+ }
+ ]
+ },
+ "Roo.KeyMap": {
+ "props": [],
+ "events": []
+ },
+ "Roo.KeyNav": {
+ "props": [
+ {
+ "name": "disabled",
"type": "Boolean",
- "desc": "True to display a title bar (defaults to true)",
+ "desc": "True to disable this KeyNav instance (defaults to false)",
"memberOf": ""
},
{
- "name": "title",
+ "name": "defaultEventAction",
"type": "String",
- "desc": "The title for the region (overrides panel titles)",
+ "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": ""
},
{
- "name": "animate",
+ "name": "forceKeyDown",
"type": "Boolean",
- "desc": "True to animate expand/collapse (defaults to false)",
+ "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": ""
- },
+ }
+ ],
+ "events": []
+ },
+ "Roo.Layer": {
+ "props": [
{
- "name": "autoHide",
+ "name": "shim",
"type": "Boolean",
- "desc": "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
+ "desc": "False to disable the iframe shim in browsers which need one (defaults to true)",
"memberOf": ""
},
{
- "name": "preservePanels",
- "type": "Boolean",
- "desc": "True to preserve removed panels so they can be readded later (defaults to false)",
+ "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": ""
},
{
- "name": "closeOnTab",
- "type": "Boolean",
- "desc": "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
+ "name": "dh",
+ "type": "Object",
+ "desc": "DomHelper object config to create element with (defaults to {tag: \"div\", cls: \"x-layer\"}).",
"memberOf": ""
},
{
- "name": "hideTabs",
+ "name": "constrain",
"type": "Boolean",
- "desc": "True to hide the tab strip (defaults to false)",
+ "desc": "False to disable constrain to viewport (defaults to true)",
"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\nthe space available, similar to FireFox 1.5 tabs (defaults to false)",
+ "name": "cls",
+ "type": "String",
+ "desc": "CSS class to add to the element",
"memberOf": ""
},
{
- "name": "minTabWidth",
+ "name": "zindex",
"type": "Number",
- "desc": "The minimum tab width (defaults to 40)",
+ "desc": "Starting z-index (defaults to 11000)",
"memberOf": ""
},
{
- "name": "preferredTabWidth",
+ "name": "shadowOffset",
"type": "Number",
- "desc": "The preferred tab width (defaults to 150)",
- "memberOf": ""
- },
- {
- "name": "showPin",
- "type": "Boolean",
- "desc": "True to show a pin button",
- "memberOf": ""
- },
- {
- "name": "hidden",
- "type": "Boolean",
- "desc": "True to start the region hidden (defaults to false)",
- "memberOf": ""
- },
- {
- "name": "hideWhenEmpty",
- "type": "Boolean",
- "desc": "True to hide the region when it has no panels",
- "memberOf": ""
- },
- {
- "name": "disableTabTips",
- "type": "Boolean",
- "desc": "True to disable tab tooltips",
- "memberOf": ""
- },
- {
- "name": "width",
- "type": "Number",
- "desc": "For East/West panels",
- "memberOf": ""
- },
- {
- "name": "height",
- "type": "Number",
- "desc": "For North/South panels",
- "memberOf": ""
- },
- {
- "name": "split",
- "type": "Boolean",
- "desc": "To show the splitter",
- "memberOf": ""
- }
- ],
- "events": []
- },
- "Roo.LoadMask": {
- "props": [
- {
- "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"
- },
- {
- "name": "msg",
- "type": "String",
- "desc": "The text to display in a centered loading message box (defaults to 'Loading...')",
- "memberOf": ""
- },
- {
- "name": "msgCls",
- "type": "String",
- "desc": "The CSS class to apply to the loading message element (defaults to \"x-mask-loading\")",
+ "desc": "Number of pixels to offset the shadow (defaults to 3)",
"memberOf": ""
}
],
"events": []
},
- "Roo.Login": {
+ "Roo.LayoutDialog": {
"props": [
{
- "name": "method",
- "type": "String",
- "desc": "Method used to query for login details.",
- "memberOf": ""
+ "name": "autoCreate",
+ "type": "Boolean/DomHelper",
+ "desc": "True to auto create from scratch, or using a DomHelper Object (defaults to false)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "url",
+ "name": "title",
"type": "String",
- "desc": "URL to query login data. - eg. baseURL + '/Login.php'",
- "memberOf": ""
- }
- ],
- "events": []
- },
- "Roo.MasterTemplate": {
- "props": [],
- "events": []
- },
- "Roo.MessageBox": {
- "props": [],
- "events": []
- },
- "Roo.NestedLayoutPanel": {
- "props": [],
- "events": []
- },
- "Roo.PagingToolbar": {
- "props": [
- {
- "name": "dataSource",
- "type": "Roo.data.Store",
- "desc": "The underlying data store providing the paged data",
- "memberOf": ""
+ "desc": "Default text to display in the title bar (defaults to null)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "container",
- "type": "String/HTMLElement/Element",
- "desc": "container The id or element that will contain the toolbar",
- "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"
},
{
- "name": "displayInfo",
- "type": "Boolean",
- "desc": "True to display the displayMsg (defaults to false)",
- "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"
},
{
- "name": "pageSize",
+ "name": "x",
"type": "Number",
- "desc": "The number of records to display per page (defaults to 20)",
- "memberOf": ""
+ "desc": "The default left page coordinate of the dialog (defaults to center screen)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "displayMsg",
- "type": "String",
- "desc": "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")",
- "memberOf": ""
+ "name": "y",
+ "type": "Number",
+ "desc": "The default top page coordinate of the dialog (defaults to center screen)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "emptyMsg",
- "type": "String",
- "desc": "The message to display when no records are found (defaults to \"No data to display\")",
- "memberOf": ""
- }
- ],
- "events": []
- },
- "Roo.QuickTips": {
- "props": [],
- "events": []
- },
- "Roo.ReaderLayout": {
- "props": [],
- "events": []
- },
- "Roo.Resizable": {
- "props": [
- {
- "name": "resizeChild",
- "type": "Boolean/String/Element",
- "desc": "True to resize the first child, or id/element to resize (defaults to false)",
- "memberOf": ""
+ "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": "adjustments",
- "type": "Array/String",
- "desc": "String \"auto\" or an array [width, height] with values to be <b>added</b> to the\nresize operation's new size (defaults to [0, 0])",
- "memberOf": ""
+ "name": "resizable",
+ "type": "Boolean",
+ "desc": "False to disable manual dialog resizing (defaults to true)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "minWidth",
- "type": "Number",
- "desc": "The minimum width for the element (defaults to 5)",
- "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"
},
{
"name": "minHeight",
"type": "Number",
- "desc": "The minimum height for the element (defaults to 5)",
- "memberOf": ""
+ "desc": "The minimum allowable height for a resizable dialog (defaults to 80)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "maxWidth",
+ "name": "minWidth",
"type": "Number",
- "desc": "The maximum width for the element (defaults to 10000)",
- "memberOf": ""
+ "desc": "The minimum allowable width for a resizable dialog (defaults to 200)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "maxHeight",
- "type": "Number",
- "desc": "The maximum height for the element (defaults to 10000)",
- "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"
},
{
- "name": "enabled",
+ "name": "autoScroll",
"type": "Boolean",
- "desc": "False to disable resizing (defaults to true)",
- "memberOf": ""
+ "desc": "True to allow the dialog body contents to overflow and display scrollbars (defaults to false)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "wrap",
+ "name": "closable",
"type": "Boolean",
- "desc": "True to wrap an element with a div if needed (required for textareas and images, defaults to false)",
- "memberOf": ""
+ "desc": "False to remove the built-in top-right corner close button (defaults to true)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "width",
- "type": "Number",
- "desc": "The width of the element in pixels (defaults to null)",
- "memberOf": ""
+ "name": "collapsible",
+ "type": "Boolean",
+ "desc": "False to remove the built-in top-right corner collapse button (defaults to true)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "height",
- "type": "Number",
- "desc": "The height of the element in pixels (defaults to null)",
- "memberOf": ""
+ "name": "constraintoviewport",
+ "type": "Boolean",
+ "desc": "True to keep the dialog constrained within the visible viewport boundaries (defaults to true)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "animate",
+ "name": "syncHeightBeforeShow",
"type": "Boolean",
- "desc": "True to animate the resize (not compatible with dynamic sizing, defaults to false)",
- "memberOf": ""
+ "desc": "True to cause the dimensions to be recalculated before the dialog is shown (defaults to false)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "duration",
- "type": "Number",
- "desc": "Animation duration if animate = true (defaults to .35)",
- "memberOf": ""
+ "name": "draggable",
+ "type": "Boolean",
+ "desc": "False to disable dragging of the dialog within the viewport (defaults to true)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "dynamic",
+ "name": "autoTabs",
"type": "Boolean",
- "desc": "True to resize the element while dragging instead of using a proxy (defaults to false)",
- "memberOf": ""
+ "desc": "If true, all elements with class 'x-dlg-tab' will get automatically converted to tabs (defaults to false)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "handles",
+ "name": "tabTag",
"type": "String",
- "desc": "String consisting of the resize handles to display (defaults to undefined)",
- "memberOf": ""
+ "desc": "The tag name of tab elements, used when autoTabs = true (defaults to 'div')",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "multiDirectional",
+ "name": "proxyDrag",
"type": "Boolean",
- "desc": "<b>Deprecated</b>. The old style of adding multi-direction resize handles, deprecated\nin favor of the handles config option (defaults to false)",
- "memberOf": ""
+ "desc": "True to drag a lightweight proxy element rather than the dialog itself, used when\ndraggable = true (defaults to false)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "disableTrackOver",
+ "name": "fixedcenter",
"type": "Boolean",
- "desc": "True to disable mouse tracking. This is only applied at config time. (defaults to false)",
- "memberOf": ""
+ "desc": "True to ensure that anytime the dialog is shown or resized it gets centered (defaults to false)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "easing",
- "type": "String",
- "desc": "Animation easing if animate = true (defaults to 'easingOutStrong')",
- "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"
},
{
- "name": "widthIncrement",
+ "name": "shadowOffset",
"type": "Number",
- "desc": "The increment to snap the width resize in pixels (dynamic must be true, defaults to 0)",
- "memberOf": ""
+ "desc": "The number of pixels to offset the shadow if displayed (defaults to 5)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "heightIncrement",
- "type": "Number",
- "desc": "The increment to snap the height resize in pixels (dynamic must be true, defaults to 0)",
- "memberOf": ""
+ "name": "buttonAlign",
+ "type": "String",
+ "desc": "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"right\")",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "pinned",
- "type": "Boolean",
- "desc": "True to ensure that the resize handles are always visible, false to display them only when the\nuser mouses over the resizable borders. This is only applied at config time. (defaults to false)",
- "memberOf": ""
+ "name": "minButtonWidth",
+ "type": "Number",
+ "desc": "Minimum width of all dialog buttons (defaults to 75)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "preserveRatio",
- "type": "Boolean",
- "desc": "True to preserve the original ratio between height and width during resize (defaults to false)",
- "memberOf": ""
+ "name": "buttons",
+ "type": "Array",
+ "desc": "Array of buttons",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "transparent",
+ "name": "shim",
"type": "Boolean",
- "desc": "True for transparent handles. This is only applied at config time. (defaults to false)",
- "memberOf": ""
+ "desc": "True to create an iframe shim that prevents selects from showing through (defaults to false)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "minX",
- "type": "Number",
- "desc": "The minimum allowed page X for the element (only used for west resizing, defaults to 0)",
- "memberOf": ""
- },
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
{
- "name": "minY",
- "type": "Number",
- "desc": "The minimum allowed page Y for the element (only used for north resizing, defaults to 0)",
- "memberOf": ""
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before this dialog is hidden."
},
{
- "name": "draggable",
- "type": "Boolean",
- "desc": "Convenience to initialize drag drop (defaults to false)",
- "memberOf": ""
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before this dialog is shown."
},
{
- "name": "constrainTo",
- "type": "String/HTMLElement/Element",
- "desc": "Constrain the resize to a particular element",
- "memberOf": ""
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this dialog is hidden."
},
{
- "name": "resizeRegion",
- "type": "Roo.lib.Region",
- "desc": "Constrain the resize to a particular region",
- "memberOf": ""
- }
- ],
- "events": [
- {
- "name": "beforeresize",
+ "name": "keydown",
"sig": "function (_self, e)\n{\n\n}",
"type": "function",
- "desc": "Fired before resize is allowed. Set enabled to false to cancel resize."
+ "desc": "Fires when a key is pressed"
+ },
+ {
+ "name": "move",
+ "sig": "function (_self, x, y)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this dialog is moved by the user."
},
{
"name": "resize",
- "sig": "function (_self, width, height, e)\n{\n\n}",
+ "sig": "function (_self, width, height)\n{\n\n}",
"type": "function",
- "desc": "Fired after a resize."
+ "desc": "Fires when this dialog is resized by the user."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this dialog is shown."
}
]
},
- "Roo.Shadow": {
+ "Roo.LayoutManager": {
"props": [
{
- "name": "mode",
- "type": "String",
- "desc": "The shadow display mode. Supports the following options:<br />\nsides: Shadow displays on both sides and bottom only<br />\nframe: Shadow displays equally on all four sides<br />\ndrop: Traditional bottom-right drop shadow (default)",
- "memberOf": "Roo"
- },
- {
- "name": "offset",
- "type": "String",
- "desc": "The number of pixels to offset the shadow from the element (defaults to 4)",
- "memberOf": ""
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
- "events": []
- },
- "Roo.SplitBar": {
- "props": [],
"events": [
{
- "name": "beforeresize",
+ "name": "layout",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires before the splitter is dragged"
+ "desc": "Fires when a layout is performed."
},
{
- "name": "moved",
- "sig": "function (_self, newSize)\n{\n\n}",
+ "name": "regioncollapsed",
+ "sig": "function (region)\n{\n\n}",
"type": "function",
- "desc": "Fires when the splitter is moved"
+ "desc": "Fires when a region is collapsed."
},
{
- "name": "resize",
- "sig": "function (_self, newSize)\n{\n\n}",
+ "name": "regionexpanded",
+ "sig": "function (region)\n{\n\n}",
"type": "function",
- "desc": "Fires when the splitter is moved (alias for {@link #event-moved})"
+ "desc": "Fires when a region is expanded."
+ },
+ {
+ "name": "regionresized",
+ "sig": "function (region, newSize)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the user resizes a region."
}
]
},
- "Roo.SplitBar.AbsoluteLayoutAdapter": {
- "props": [],
- "events": []
- },
- "Roo.SplitBar.BasicLayoutAdapter": {
- "props": [],
- "events": []
- },
- "Roo.SplitButton": {
+ "Roo.LayoutRegion": {
"props": [
{
- "name": "arrowHandler",
- "type": "Function",
- "desc": "A function called when the arrow button is clicked (can be used instead of click event)",
+ "name": "collapsible",
+ "type": "Boolean",
+ "desc": "False to disable collapsing (defaults to true)",
"memberOf": ""
},
{
- "name": "arrowTooltip",
- "type": "String",
- "desc": "The title attribute of the arrow",
+ "name": "collapsed",
+ "type": "Boolean",
+ "desc": "True to set the initial display to collapsed (defaults to false)",
"memberOf": ""
- }
- ],
- "events": [
+ },
{
- "name": "arrowclick",
- "sig": "function (_self, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this button's arrow is clicked"
- }
- ]
- },
- "Roo.SplitLayoutRegion": {
- "props": [],
- "events": []
- },
- "Roo.TabPanel": {
- "props": [],
- "events": [
+ "name": "floatable",
+ "type": "Boolean",
+ "desc": "False to disable floating (defaults to true)",
+ "memberOf": ""
+ },
{
- "name": "beforetabchange",
- "sig": "function (_self, e, tab)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change"
+ "name": "margins",
+ "type": "Object",
+ "desc": "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
+ "memberOf": ""
},
{
- "name": "tabchange",
- "sig": "function (_self, activePanel)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the active tab changes"
- }
- ]
- },
- "Roo.TabPanelItem": {
- "props": [],
- "events": [
+ "name": "cmargins",
+ "type": "Object",
+ "desc": "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})",
+ "memberOf": ""
+ },
{
- "name": "activate",
- "sig": "function (tabPanel, _self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this tab becomes the active tab."
+ "name": "tabPosition",
+ "type": "String",
+ "desc": "\"top\" or \"bottom\" (defaults to \"bottom\")",
+ "memberOf": ""
},
{
- "name": "beforeclose",
- "sig": "function (_self, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true)."
+ "name": "collapsedTitle",
+ "type": "String",
+ "desc": "Optional string message to display in the collapsed block of a north or south region",
+ "memberOf": ""
},
{
- "name": "close",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this tab is closed."
+ "name": "alwaysShowTabs",
+ "type": "Boolean",
+ "desc": "True to always display tabs even when there is only 1 panel (defaults to false)",
+ "memberOf": ""
},
{
- "name": "deactivate",
- "sig": "function (tabPanel, _self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this tab is no longer the active tab."
- }
- ]
- },
- "Roo.Template": {
- "props": [],
- "events": []
- },
- "Roo.Toolbar": {
- "props": [
+ "name": "autoScroll",
+ "type": "Boolean",
+ "desc": "True to enable overflow scrolling (defaults to false)",
+ "memberOf": ""
+ },
{
- "name": "items",
- "type": "Roo.data.Store",
- "desc": "array of button configs or elements to add",
- "memberOf": "Roo"
+ "name": "titlebar",
+ "type": "Boolean",
+ "desc": "True to display a title bar (defaults to true)",
+ "memberOf": ""
},
{
- "name": "container",
- "type": "String/HTMLElement/Element",
- "desc": "The id or element that will contain the toolbar",
+ "name": "title",
+ "type": "String",
+ "desc": "The title for the region (overrides panel titles)",
"memberOf": ""
- }
- ],
- "events": []
- },
- "Roo.Toolbar.Button": {
- "props": [],
- "events": []
- },
- "Roo.Toolbar.Fill": {
- "props": [],
- "events": []
- },
- "Roo.Toolbar.Item": {
- "props": [],
- "events": []
- },
- "Roo.Toolbar.Separator": {
- "props": [],
- "events": []
- },
- "Roo.Toolbar.Spacer": {
- "props": [],
- "events": []
- },
- "Roo.Toolbar.SplitButton": {
- "props": [],
- "events": []
- },
- "Roo.Toolbar.TextItem": {
- "props": [],
- "events": []
- },
- "Roo.TreePanel": {
- "props": [
- {
- "name": "tree",
- "type": "Roo.tree.TreePanel",
- "desc": "The tree TreePanel, with config etc.",
- "memberOf": "Roo"
- }
- ],
- "events": []
- },
- "Roo.UpdateManager": {
- "props": [],
- "events": [
- {
- "name": "beforeupdate",
- "sig": "function (el, url, params)\n{\n\n}",
- "type": "function",
- "desc": "Fired before an update is made, return false from your handler and the update is cancelled."
- },
- {
- "name": "failure",
- "sig": "function (el, oResponseObject)\n{\n\n}",
- "type": "function",
- "desc": "Fired on update failure."
- },
- {
- "name": "update",
- "sig": "function (el, oResponseObject)\n{\n\n}",
- "type": "function",
- "desc": "Fired after successful update is made."
- }
- ]
- },
- "Roo.UpdateManager.BasicRenderer": {
- "props": [],
- "events": []
- },
- "Roo.UpdateManager.defaults": {
- "props": [],
- "events": []
- },
- "Roo.View": {
- "props": [],
- "events": [
- {
- "name": "beforeclick",
- "sig": "function (_self, index, node, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires before a click is processed. Returns false to cancel the default action."
- },
- {
- "name": "beforeselect",
- "sig": "function (_self, node, selections)\n{\n\n}",
- "type": "function",
- "desc": "Fires before a selection is made. If any handlers return false, the selection is cancelled."
},
{
- "name": "click",
- "sig": "function (_self, index, node, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a template node is clicked."
+ "name": "animate",
+ "type": "Boolean",
+ "desc": "True to animate expand/collapse (defaults to false)",
+ "memberOf": ""
},
{
- "name": "contextmenu",
- "sig": "function (_self, index, node, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a template node is right clicked."
+ "name": "autoHide",
+ "type": "Boolean",
+ "desc": "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
+ "memberOf": ""
},
{
- "name": "dblclick",
- "sig": "function (_self, index, node, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a template node is double clicked."
+ "name": "preservePanels",
+ "type": "Boolean",
+ "desc": "True to preserve removed panels so they can be readded later (defaults to false)",
+ "memberOf": ""
},
{
- "name": "selectionchange",
- "sig": "function (_self, selections)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the selected nodes change."
- }
- ]
- },
- "Roo.XComponent": {
- "props": [
- {
- "name": "disabled",
- "type": "Function|boolean",
- "desc": "If this module is disabled by some rule, return true from the funtion",
+ "name": "closeOnTab",
+ "type": "Boolean",
+ "desc": "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
"memberOf": ""
},
{
- "name": "parent",
- "type": "String",
- "desc": "Name of parent element which it get xtype added to..",
+ "name": "hideTabs",
+ "type": "Boolean",
+ "desc": "True to hide the tab strip (defaults to false)",
"memberOf": ""
},
{
- "name": "order",
- "type": "String",
- "desc": "Used to set the order in which elements are created (usefull for multiple tabs)",
+ "name": "resizeTabs",
+ "type": "Boolean",
+ "desc": "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)",
"memberOf": ""
},
{
- "name": "name",
- "type": "String",
- "desc": "String to display while loading.",
+ "name": "minTabWidth",
+ "type": "Number",
+ "desc": "The minimum tab width (defaults to 40)",
"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...",
+ "name": "preferredTabWidth",
+ "type": "Number",
+ "desc": "The preferred tab width (defaults to 150)",
"memberOf": ""
- }
- ],
- "events": [
- {
- "name": "buildcomplete",
- "sig": "function (c)\n{\n\n}",
- "type": "function",
- "desc": "Fires on the top level element when all elements have been built"
},
{
- "name": "built",
- "sig": "function (c)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this the componnt is built"
- }
- ]
- },
- "Roo.data": {
- "props": [],
- "events": []
- },
- "Roo.data.ArrayReader": {
- "props": [
- {
- "name": "id",
- "type": "String",
- "desc": "(optional) The subscript within row Array that provides an ID for the Record",
+ "name": "showPin",
+ "type": "Boolean",
+ "desc": "True to show a pin button",
"memberOf": ""
- }
- ],
- "events": []
- },
- "Roo.data.Connection": {
- "props": [
+ },
{
- "name": "url",
- "type": "String",
- "desc": "(Optional) The default URL to be used for requests to the server. (defaults to undefined)",
+ "name": "hidden",
+ "type": "Boolean",
+ "desc": "True to start the region hidden (defaults to false)",
"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)",
+ "name": "hideWhenEmpty",
+ "type": "Boolean",
+ "desc": "True to hide the region when it has no panels",
"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)",
+ "name": "disableTabTips",
+ "type": "Boolean",
+ "desc": "True to disable tab tooltips",
"memberOf": ""
},
{
- "name": "method",
- "type": "String",
- "desc": "(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)",
+ "name": "width",
+ "type": "Number",
+ "desc": "For East/West panels",
"memberOf": ""
},
{
- "name": "timeout",
+ "name": "height",
"type": "Number",
- "desc": "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
+ "desc": "For North/South panels",
"memberOf": ""
},
{
- "name": "autoAbort",
+ "name": "split",
"type": "Boolean",
- "desc": "(Optional) Whether this request should abort any pending requests. (defaults to false)",
+ "desc": "To show the splitter",
"memberOf": ""
},
{
- "name": "disableCaching",
+ "name": "toolbar",
"type": "Boolean",
- "desc": "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
+ "desc": "xtype configuration for a toolbar - shows on right of tabbar",
"memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
"events": [
{
- "name": "beforerequest",
- "sig": "function (conn, options)\n{\n\n}",
+ "name": "beforeremove",
+ "sig": "function (_self, panel, e)\n{\n\n}",
"type": "function",
- "desc": "Fires before a network request is made to retrieve a data object."
+ "desc": "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument."
},
{
- "name": "requestcomplete",
- "sig": "function (conn, response, options)\n{\n\n}",
+ "name": "collapsed",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires if the request was successfully completed."
+ "desc": "Fires when this region is collapsed."
},
{
- "name": "requestexception",
- "sig": "function (conn, response, options)\n{\n\n}",
+ "name": "expanded",
+ "sig": "function (_self)\n{\n\n}",
"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."
- }
- ]
- },
- "Roo.data.DataProxy": {
- "props": [],
- "events": [
+ "desc": "Fires when this region is expanded."
+ },
{
- "name": "beforeload",
- "sig": "function (This, params)\n{\n\n}",
+ "name": "invalidated",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires before a network request is made to retrieve a data object."
+ "desc": "Fires when the layout for this region is changed."
},
{
- "name": "load",
- "sig": "function (This, o, arg)\n{\n\n}",
+ "name": "panelactivated",
+ "sig": "function (_self, panel)\n{\n\n}",
"type": "function",
- "desc": "Fires before the load method's callback is called."
+ "desc": "Fires when a panel is activated."
},
{
- "name": "loadexception",
- "sig": "function (This, o, arg, e)\n{\n\n}",
+ "name": "paneladded",
+ "sig": "function (_self, panel)\n{\n\n}",
"type": "function",
- "desc": "Fires if an Exception occurs during data retrieval."
- }
- ]
- },
- "Roo.data.DataReader": {
- "props": [],
- "events": []
- },
- "Roo.data.HttpProxy": {
- "props": [
- {
- "name": "url",
- "type": "String",
- "desc": "(Optional) The default URL to be used for requests to the server. (defaults to undefined)",
- "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": ""
+ "desc": "Fires when a panel is added."
},
{
- "name": "defaultHeaders",
- "type": "Object",
- "desc": "(Optional) An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
- "memberOf": ""
+ "name": "panelremoved",
+ "sig": "function (_self, panel)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a panel is removed."
},
{
- "name": "method",
- "type": "String",
- "desc": "(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)",
- "memberOf": ""
+ "name": "resized",
+ "sig": "function (_self, newSize)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the user resizes this region."
},
{
- "name": "timeout",
- "type": "Number",
- "desc": "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
- "memberOf": ""
+ "name": "slidehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this region slides out of view."
},
{
- "name": "autoAbort",
- "type": "Boolean",
- "desc": "(Optional) Whether this request should abort any pending requests. (defaults to false)",
- "memberOf": ""
+ "name": "slideshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this region is slid into view."
},
{
- "name": "disableCaching",
- "type": "Boolean",
- "desc": "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
- "memberOf": ""
+ "name": "visibilitychange",
+ "sig": "function (_self, visibility)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this region is shown or hidden"
}
- ],
- "events": []
+ ]
},
- "Roo.data.JsonReader": {
+ "Roo.LoadMask": {
"props": [
{
- "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": ""
- },
- {
- "name": "successProperty",
- "type": "String",
- "desc": "Name of the property from which to retrieve the success attribute used by forms.",
+ "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": ""
},
{
- "name": "root",
+ "name": "msg",
"type": "String",
- "desc": "name of the property which contains the Array of row objects.",
+ "desc": "The text to display in a centered loading message box (defaults to 'Loading...')",
"memberOf": ""
},
{
- "name": "id",
+ "name": "msgCls",
"type": "String",
- "desc": "Name of the property within a row object that contains a record identifier value.",
- "memberOf": ""
- }
- ],
- "events": []
- },
- "Roo.data.JsonStore": {
- "props": [
- {
- "name": "fields",
- "type": "Array",
- "desc": "An array of field definition objects, or field name strings.",
+ "desc": "The CSS class to apply to the loading message element (defaults to \"x-mask-loading\")",
"memberOf": ""
}
],
"events": []
},
- "Roo.data.MemoryProxy": {
- "props": [],
- "events": []
- },
- "Roo.data.Node": {
+ "Roo.Login": {
"props": [
{
- "name": "leaf",
- "type": "Boolean",
- "desc": "true if this node is a leaf and does not have children",
+ "name": "method",
+ "type": "String",
+ "desc": "Method used to query for login details.",
"memberOf": ""
},
{
- "name": "id",
+ "name": "url",
"type": "String",
- "desc": "The id for this node. If one is not specified, one is generated.",
+ "desc": "URL to query login data. - eg. baseURL + '/Login.php'",
"memberOf": ""
- }
- ],
- "events": [
+ },
{
- "name": "append",
- "sig": "function (tree, _self, node, index)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a new child node is appended"
+ "name": "autoCreate",
+ "type": "Boolean/DomHelper",
+ "desc": "True to auto create from scratch, or using a DomHelper Object (defaults to false)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "beforeappend",
- "sig": "function (tree, _self, node)\n{\n\n}",
- "type": "function",
- "desc": "Fires before a new child is appended, return false to cancel the append."
+ "name": "title",
+ "type": "String",
+ "desc": "Default text to display in the title bar (defaults to null)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "beforeinsert",
- "sig": "function (tree, _self, node, refNode)\n{\n\n}",
- "type": "function",
- "desc": "Fires before a new child is inserted, return false to cancel the insert."
+ "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": "beforemove",
- "sig": "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
- "type": "function",
- "desc": "Fires before this node is moved to a new location in the tree. Return false to cancel the move."
+ "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"
},
{
- "name": "beforeremove",
- "sig": "function (tree, _self, node)\n{\n\n}",
- "type": "function",
- "desc": "Fires before a child is removed, return false to cancel the remove."
+ "name": "x",
+ "type": "Number",
+ "desc": "The default left page coordinate of the dialog (defaults to center screen)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "insert",
- "sig": "function (tree, _self, node, refNode)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a new child node is inserted."
+ "name": "y",
+ "type": "Number",
+ "desc": "The default top page coordinate of the dialog (defaults to center screen)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "move",
- "sig": "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this node is moved to a new location in the tree"
+ "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": "remove",
- "sig": "function (tree, _self, node)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a child node is removed"
- }
- ]
- },
- "Roo.data.Record": {
- "props": [],
- "events": []
- },
- "Roo.data.ScriptTagProxy": {
- "props": [
+ "name": "resizable",
+ "type": "Boolean",
+ "desc": "False to disable manual dialog resizing (defaults to true)",
+ "memberOf": "Roo.BasicDialog"
+ },
{
- "name": "url",
+ "name": "resizeHandles",
"type": "String",
- "desc": "The URL from which to request the data object.",
- "memberOf": ""
+ "desc": "Which resize handles to display - see the {@link Roo.Resizable} handles config\nproperty for valid values (defaults to 'all')",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "timeout",
+ "name": "minHeight",
"type": "Number",
- "desc": "(Optional) The number of milliseconds to wait for a response. Defaults to 30 seconds.",
- "memberOf": ""
+ "desc": "The minimum allowable height for a resizable dialog (defaults to 80)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "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\".<p>The server-side processing must read this parameter value, and generate\njavascript output which calls this named function passing the data object as its only parameter.",
- "memberOf": ""
+ "name": "minWidth",
+ "type": "Number",
+ "desc": "The minimum allowable width for a resizable dialog (defaults to 200)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "nocache",
+ "name": "modal",
"type": "Boolean",
- "desc": "(Optional) Defaults to true. Disable cacheing by adding a unique parameter\nname to the request.",
- "memberOf": ""
- }
- ],
- "events": []
- },
- "Roo.data.SimpleStore": {
- "props": [
- {
- "name": "id",
- "type": "Number",
- "desc": "The array index of the record id. Leave blank to auto generate ids.",
- "memberOf": ""
+ "desc": "True to show the dialog modally, preventing user interaction with the rest of the page (defaults to false)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "fields",
- "type": "Array",
- "desc": "An array of field definition objects, or field name strings.",
- "memberOf": ""
+ "name": "autoScroll",
+ "type": "Boolean",
+ "desc": "True to allow the dialog body contents to overflow and display scrollbars (defaults to false)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "data",
- "type": "Array",
- "desc": "The multi-dimensional array of data",
- "memberOf": ""
- }
- ],
- "events": []
- },
- "Roo.data.SortTypes": {
- "props": [],
- "events": []
- },
- "Roo.data.Store": {
- "props": [
- {
- "name": "isLocal",
- "type": "boolean",
- "desc": "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
- "memberOf": ""
+ "name": "closable",
+ "type": "Boolean",
+ "desc": "False to remove the built-in top-right corner close button (defaults to true)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "proxy",
- "type": "Roo.data.DataProxy",
- "desc": "The Proxy object which provides access to a data object.",
- "memberOf": ""
+ "name": "collapsible",
+ "type": "Boolean",
+ "desc": "False to remove the built-in top-right corner collapse button (defaults to true)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "data",
- "type": "Array",
- "desc": "Inline data to be loaded when the store is initialized.",
- "memberOf": ""
+ "name": "constraintoviewport",
+ "type": "Boolean",
+ "desc": "True to keep the dialog constrained within the visible viewport boundaries (defaults to true)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "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 <em>id</em> property.",
- "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"
},
{
- "name": "baseParams",
- "type": "Object",
- "desc": "An object containing properties which are to be sent as parameters\non any HTTP request",
- "memberOf": ""
+ "name": "draggable",
+ "type": "Boolean",
+ "desc": "False to disable dragging of the dialog within the viewport (defaults to true)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "sortInfo",
- "type": "Object",
- "desc": "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
- "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"
},
{
- "name": "remoteSort",
- "type": "boolean",
- "desc": "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
- "memberOf": ""
+ "name": "tabTag",
+ "type": "String",
+ "desc": "The tag name of tab elements, used when autoTabs = true (defaults to 'div')",
+ "memberOf": "Roo.BasicDialog"
},
{
- "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": ""
- }
- ],
- "events": [
- {
- "name": "add",
- "sig": "function (_self, records, index)\n{\n\n}",
- "type": "function",
- "desc": "Fires when Records have been added to the Store"
+ "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": "beforeload",
- "sig": "function (_self, options)\n{\n\n}",
- "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."
+ "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"
},
{
- "name": "clear",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the data cache has been cleared."
+ "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": "datachanged",
- "sig": "function (_self)\n{\n\n}",
- "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."
+ "name": "shadowOffset",
+ "type": "Number",
+ "desc": "The number of pixels to offset the shadow if displayed (defaults to 5)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "load",
- "sig": "function (_self, records, options)\n{\n\n}",
- "type": "function",
- "desc": "Fires after a new set of Records has been loaded."
+ "name": "buttonAlign",
+ "type": "String",
+ "desc": "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"right\")",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "loadexception",
- "sig": "function (, return, load, jsonData)\n{\n\n}",
- "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"
+ "name": "minButtonWidth",
+ "type": "Number",
+ "desc": "Minimum width of all dialog buttons (defaults to 75)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "metachange",
- "sig": "function (_self, meta)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders."
+ "name": "buttons",
+ "type": "Array",
+ "desc": "Array of buttons",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "remove",
- "sig": "function (_self, record, index)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a Record has been removed from the Store"
+ "name": "shim",
+ "type": "Boolean",
+ "desc": "True to create an iframe shim that prevents selects from showing through (defaults to false)",
+ "memberOf": "Roo.BasicDialog"
},
{
- "name": "update",
- "sig": "function (_self, record, operation)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a Record has been updated"
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
- ]
- },
- "Roo.data.Tree": {
- "props": [],
+ ],
"events": [
{
- "name": "append",
- "sig": "function (tree, parent, node, index)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a new child node is appended to a node in this tree."
- },
- {
- "name": "beforeappend",
- "sig": "function (tree, parent, node)\n{\n\n}",
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires before a new child is appended to a node in this tree, return false to cancel the append."
+ "desc": "Fires before this dialog is hidden."
},
{
- "name": "beforeinsert",
- "sig": "function (tree, parent, node, refNode)\n{\n\n}",
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires before a new child is inserted in a node in this tree, return false to cancel the insert."
+ "desc": "Fires before this dialog is shown."
},
{
- "name": "beforemove",
- "sig": "function (tree, node, oldParent, newParent, index)\n{\n\n}",
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires before a node is moved to a new location in the tree. Return false to cancel the move."
+ "desc": "Fires when this dialog is hidden."
},
{
- "name": "beforeremove",
- "sig": "function (tree, parent, node)\n{\n\n}",
+ "name": "keydown",
+ "sig": "function (_self, e)\n{\n\n}",
"type": "function",
- "desc": "Fires before a child is removed from a node in this tree, return false to cancel the remove."
+ "desc": "Fires when a key is pressed"
},
{
- "name": "insert",
- "sig": "function (tree, parent, node, refNode)\n{\n\n}",
+ "name": "move",
+ "sig": "function (_self, x, y)\n{\n\n}",
"type": "function",
- "desc": "Fires when a new child node is inserted in a node in this tree."
+ "desc": "Fires when this dialog is moved by the user."
},
{
- "name": "move",
- "sig": "function (tree, node, oldParent, newParent, index)\n{\n\n}",
+ "name": "resize",
+ "sig": "function (_self, width, height)\n{\n\n}",
"type": "function",
- "desc": "Fires when a node is moved to a new location in the tree"
+ "desc": "Fires when this dialog is resized by the user."
},
{
- "name": "remove",
- "sig": "function (tree, parent, node)\n{\n\n}",
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a child node is removed from a node in this tree."
+ "desc": "Fires when this dialog is shown."
}
]
},
- "Roo.data.XmlReader": {
+ "Roo.MasterTemplate": {
"props": [
{
- "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": ""
- },
- {
- "name": "record",
- "type": "String",
- "desc": "The DomQuery path to the repeated element which contains record information.",
- "memberOf": ""
- },
- {
- "name": "success",
- "type": "String",
- "desc": "The DomQuery path to the success attribute used by forms.",
- "memberOf": ""
- },
- {
- "name": "id",
+ "name": "html",
"type": "String",
- "desc": "The DomQuery path relative from the record element to the element that contains\na record identifier value.",
- "memberOf": ""
+ "desc": "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")",
+ "memberOf": "Roo.Template"
}
],
"events": []
},
- "Roo.dd": {
- "props": [],
- "events": []
- },
- "Roo.dd.DD": {
- "props": [],
- "events": []
- },
- "Roo.dd.DDProxy": {
- "props": [],
- "events": []
- },
- "Roo.dd.DDTarget": {
- "props": [],
- "events": []
- },
- "Roo.dd.DragDrop": {
- "props": [],
- "events": []
- },
- "Roo.dd.DragDropMgr": {
+ "Roo.MessageBox": {
"props": [],
"events": []
},
- "Roo.dd.DragSource": {
+ "Roo.NestedLayoutPanel": {
"props": [
{
- "name": "dropAllowed",
- "type": "String",
- "desc": "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
- "memberOf": ""
+ "name": "fitToFrame",
+ "type": "Boolean",
+ "desc": "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
+ "memberOf": "Roo.ContentPanel"
},
{
- "name": "dropNotAllowed",
- "type": "String",
- "desc": "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
- "memberOf": ""
- }
- ],
- "events": []
- },
- "Roo.dd.DragZone": {
- "props": [
- {
- "name": "containerScroll",
+ "name": "fitContainer",
"type": "Boolean",
- "desc": "True to register this container with the Scrollmanager\nfor auto scrolling during drag operations.",
- "memberOf": ""
+ "desc": "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
+ "memberOf": "Roo.ContentPanel"
},
{
- "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": ""
- }
- ],
- "events": []
- },
- "Roo.dd.DropTarget": {
- "props": [
+ "name": "autoCreate",
+ "type": "Boolean/Object",
+ "desc": "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
+ "memberOf": "Roo.ContentPanel"
+ },
{
- "name": "overClass",
- "type": "String",
- "desc": "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").",
- "memberOf": ""
+ "name": "closable",
+ "type": "Boolean",
+ "desc": "True if the panel can be closed/removed",
+ "memberOf": "Roo.ContentPanel"
},
{
- "name": "dropAllowed",
- "type": "String",
- "desc": "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
- "memberOf": ""
+ "name": "background",
+ "type": "Boolean",
+ "desc": "True if the panel should not be activated when it is added (defaults to false)",
+ "memberOf": "Roo.ContentPanel"
},
{
- "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": ""
- }
- ],
- "events": []
- },
- "Roo.dd.DropZone": {
- "props": [],
- "events": []
- },
- "Roo.dd.Registry": {
- "props": [],
- "events": []
- },
- "Roo.dd.ScrollManager": {
- "props": [],
- "events": []
- },
- "Roo.dd.StatusProxy": {
- "props": [
+ "name": "resizeEl",
+ "type": "String/HTMLElement/Element",
+ "desc": "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
+ "memberOf": "Roo.ContentPanel"
+ },
{
- "name": "dropAllowed",
- "type": "String",
- "desc": "The CSS class to apply to the status element when drop is allowed (defaults to \"x-dd-drop-ok\").",
- "memberOf": ""
+ "name": "toolbar",
+ "type": "Toolbar",
+ "desc": "A toolbar for this panel",
+ "memberOf": "Roo.ContentPanel"
},
{
- "name": "dropNotAllowed",
- "type": "String",
- "desc": "The CSS class to apply to the status element when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
- "memberOf": ""
- }
- ],
- "events": []
- },
- "Roo.form": {
- "props": [],
- "events": []
- },
- "Roo.form.Action": {
- "props": [],
- "events": []
- },
- "Roo.form.BasicForm": {
- "props": [
+ "name": "autoScroll",
+ "type": "Boolean",
+ "desc": "True to scroll overflow in this panel (use with {@link #fitToFrame})",
+ "memberOf": "Roo.ContentPanel"
+ },
{
- "name": "method",
+ "name": "title",
"type": "String",
- "desc": "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.",
- "memberOf": ""
+ "desc": "The title for this panel",
+ "memberOf": "Roo.ContentPanel"
},
{
- "name": "reader",
- "type": "DataReader",
- "desc": "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.",
- "memberOf": ""
+ "name": "adjustments",
+ "type": "Array",
+ "desc": "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
+ "memberOf": "Roo.ContentPanel"
},
{
- "name": "errorReader",
- "type": "DataReader",
- "desc": "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on \"submit\" actions.\nThis is completely optional as there is built-in support for processing JSON.",
- "memberOf": ""
+ "name": "url",
+ "type": "String",
+ "desc": "Calls {@link #setUrl} with this value",
+ "memberOf": "Roo.ContentPanel"
},
{
- "name": "url",
+ "name": "region",
"type": "String",
- "desc": "The URL to use for form actions if one isn't supplied in the action options.",
- "memberOf": ""
+ "desc": "(center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
+ "memberOf": "Roo.ContentPanel"
},
{
- "name": "fileUpload",
- "type": "Boolean",
- "desc": "Set to true if this form is a file upload.",
- "memberOf": ""
+ "name": "params",
+ "type": "String/Object",
+ "desc": "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf": "Roo.ContentPanel"
},
{
- "name": "baseParams",
- "type": "Object",
- "desc": "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
- "memberOf": ""
+ "name": "loadOnce",
+ "type": "Boolean",
+ "desc": "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf": "Roo.ContentPanel"
},
{
- "name": "timeout",
- "type": "Number",
- "desc": "Timeout for form actions in seconds (default is 30 seconds).",
- "memberOf": ""
+ "name": "content",
+ "type": "String",
+ "desc": "Raw content to fill content panel with (uses setContent on construction.)",
+ "memberOf": "Roo.ContentPanel"
},
{
- "name": "trackResetOnLoad",
- "type": "Boolean",
- "desc": "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.",
- "memberOf": ""
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
"events": [
{
- "name": "actioncomplete",
- "sig": "function (_self, action)\n{\n\n}",
+ "name": "activate",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when an action is completed."
+ "desc": "Fires when this panel is activated."
},
{
- "name": "actionfailed",
- "sig": "function (_self, action)\n{\n\n}",
+ "name": "deactivate",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when an action fails."
+ "desc": "Fires when this panel is activated."
},
{
- "name": "beforeaction",
- "sig": "function (_self, action)\n{\n\n}",
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires before any action is performed. Return false to cancel the action."
+ "desc": "Fires when this tab is created"
+ },
+ {
+ "name": "resize",
+ "sig": "function (_self, width, height)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this panel is resized if fitToFrame is true."
}
]
},
- "Roo.form.Checkbox": {
+ "Roo.PagingToolbar": {
"props": [
{
- "name": "focusClass",
- "type": "String",
- "desc": "The CSS class to use when the checkbox receives focus (defaults to undefined)",
+ "name": "dataSource",
+ "type": "Roo.data.Store",
+ "desc": "The underlying data store providing the paged data",
"memberOf": ""
},
{
- "name": "fieldClass",
- "type": "String",
- "desc": "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "name": "container",
+ "type": "String/HTMLElement/Element",
+ "desc": "container The id or element that will contain the toolbar",
"memberOf": ""
},
{
- "name": "checked",
+ "name": "displayInfo",
"type": "Boolean",
- "desc": "True if the the checkbox should render already checked (defaults to false)",
+ "desc": "True to display the displayMsg (defaults to false)",
"memberOf": ""
},
{
- "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\"})",
+ "name": "pageSize",
+ "type": "Number",
+ "desc": "The number of records to display per page (defaults to 20)",
"memberOf": ""
},
{
- "name": "boxLabel",
+ "name": "displayMsg",
"type": "String",
- "desc": "The text that appears beside the checkbox",
+ "desc": "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")",
"memberOf": ""
},
{
- "name": "inputValue",
+ "name": "emptyMsg",
"type": "String",
- "desc": "The value that should go into the generated input element's value attribute",
+ "desc": "The message to display when no records are found (defaults to \"No data to display\")",
"memberOf": ""
},
{
- "name": "valueOff",
- "type": "String",
- "desc": "The value that should go into the generated input element's value when unchecked.",
- "memberOf": ""
+ "name": "items",
+ "type": "Array",
+ "desc": "array of button configs or elements to add (will be converted to a MixedCollection)",
+ "memberOf": "Roo.Toolbar"
+ }
+ ],
+ "events": []
+ },
+ "Roo.QuickTips": {
+ "props": [],
+ "events": []
+ },
+ "Roo.ReaderLayout": {
+ "props": [
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
"events": [
{
- "name": "check",
- "sig": "function (_self, checked)\n{\n\n}",
+ "name": "layout",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the checkbox is checked or unchecked."
+ "desc": "Fires when a layout is performed."
+ },
+ {
+ "name": "regioncollapsed",
+ "sig": "function (region)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a region is collapsed."
+ },
+ {
+ "name": "regionexpanded",
+ "sig": "function (region)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a region is expanded."
+ },
+ {
+ "name": "regionresized",
+ "sig": "function (region, newSize)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the user resizes a region."
}
]
},
- "Roo.form.Column": {
+ "Roo.Resizable": {
"props": [
{
- "name": "width",
- "type": "Number/String",
- "desc": "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
+ "name": "resizeChild",
+ "type": "Boolean/String/Element",
+ "desc": "True to resize the first child, or id/element to resize (defaults to false)",
"memberOf": ""
},
{
- "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'})",
+ "name": "adjustments",
+ "type": "Array/String",
+ "desc": "String \"auto\" or an array [width, height] with values to be <b>added</b> to the\nresize operation's new size (defaults to [0, 0])",
"memberOf": ""
- }
- ],
- "events": []
- },
- "Roo.form.ComboBox": {
- "props": [
+ },
{
- "name": "transform",
- "type": "String/HTMLElement/Element",
- "desc": "The id, DOM node or element of an existing select to convert to a ComboBox",
+ "name": "minWidth",
+ "type": "Number",
+ "desc": "The minimum width for the element (defaults to 5)",
"memberOf": ""
},
{
- "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)",
+ "name": "minHeight",
+ "type": "Number",
+ "desc": "The minimum height for the element (defaults to 5)",
"memberOf": ""
},
{
- "name": "autoCreate",
- "type": "Boolean/Object",
- "desc": "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
+ "name": "maxWidth",
+ "type": "Number",
+ "desc": "The maximum width for the element (defaults to 10000)",
"memberOf": ""
},
{
- "name": "store",
- "type": "Roo.data.Store",
- "desc": "The data store to which this combo is bound (defaults to undefined)",
+ "name": "maxHeight",
+ "type": "Number",
+ "desc": "The maximum height for the element (defaults to 10000)",
"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)",
+ "name": "enabled",
+ "type": "Boolean",
+ "desc": "False to disable resizing (defaults to true)",
"memberOf": ""
},
{
- "name": "grow",
+ "name": "wrap",
"type": "Boolean",
- "desc": "",
+ "desc": "True to wrap an element with a div if needed (required for textareas and images, defaults to false)",
"memberOf": ""
},
{
- "name": "growMin",
+ "name": "width",
"type": "Number",
- "desc": "",
+ "desc": "The width of the element in pixels (defaults to null)",
"memberOf": ""
},
{
- "name": "growMax",
+ "name": "height",
"type": "Number",
- "desc": "",
+ "desc": "The height of the element in pixels (defaults to null)",
"memberOf": ""
},
{
- "name": "tpl",
- "type": "String/Roo.Template",
- "desc": "The template to use to render the output",
+ "name": "animate",
+ "type": "Boolean",
+ "desc": "True to animate the resize (not compatible with dynamic sizing, defaults to false)",
"memberOf": ""
},
{
- "name": "listWidth",
+ "name": "duration",
"type": "Number",
- "desc": "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
- "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')",
+ "desc": "Animation duration if animate = true (defaults to .35)",
"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.",
+ "name": "dynamic",
+ "type": "Boolean",
+ "desc": "True to resize the element while dragging instead of using a proxy (defaults to false)",
"memberOf": ""
},
{
- "name": "hiddenName",
+ "name": "handles",
"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)",
+ "desc": "String consisting of the resize handles to display (defaults to undefined)",
"memberOf": ""
},
{
- "name": "listClass",
- "type": "String",
- "desc": "CSS class to apply to the dropdown list element (defaults to '')",
+ "name": "multiDirectional",
+ "type": "Boolean",
+ "desc": "<b>Deprecated</b>. The old style of adding multi-direction resize handles, deprecated\nin favor of the handles config option (defaults to false)",
"memberOf": ""
},
{
- "name": "selectedClass",
- "type": "String",
- "desc": "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
+ "name": "disableTrackOver",
+ "type": "Boolean",
+ "desc": "True to disable mouse tracking. This is only applied at config time. (defaults to false)",
"memberOf": ""
},
{
- "name": "triggerClass",
+ "name": "easing",
"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 <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
- "memberOf": ""
- },
- {
- "name": "shadow",
- "type": "Boolean/String",
- "desc": "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
+ "desc": "Animation easing if animate = true (defaults to 'easingOutStrong')",
"memberOf": ""
},
{
- "name": "listAlign",
- "type": "String",
- "desc": "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
+ "name": "widthIncrement",
+ "type": "Number",
+ "desc": "The increment to snap the width resize in pixels (dynamic must be true, defaults to 0)",
"memberOf": ""
},
{
- "name": "maxHeight",
+ "name": "heightIncrement",
"type": "Number",
- "desc": "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
+ "desc": "The increment to snap the height resize in pixels (dynamic must be true, defaults to 0)",
"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')",
+ "name": "pinned",
+ "type": "Boolean",
+ "desc": "True to ensure that the resize handles are always visible, false to display them only when the\nuser mouses over the resizable borders. This is only applied at config time. (defaults to false)",
"memberOf": ""
},
{
- "name": "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)",
+ "name": "preserveRatio",
+ "type": "Boolean",
+ "desc": "True to preserve the original ratio between height and width during resize (defaults to false)",
"memberOf": ""
},
{
- "name": "typeAhead",
+ "name": "transparent",
"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)",
+ "desc": "True for transparent handles. This is only applied at config time. (defaults to false)",
"memberOf": ""
},
{
- "name": "queryDelay",
+ "name": "minX",
"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')",
+ "desc": "The minimum allowed page X for the element (only used for west resizing, defaults to 0)",
"memberOf": ""
},
{
- "name": "pageSize",
+ "name": "minY",
"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)",
+ "desc": "The minimum allowed page Y for the element (only used for north resizing, defaults to 0)",
"memberOf": ""
},
{
- "name": "selectOnFocus",
+ "name": "draggable",
"type": "Boolean",
- "desc": "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
- "memberOf": ""
- },
- {
- "name": "queryParam",
- "type": "String",
- "desc": "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "desc": "Convenience to initialize drag drop (defaults to false)",
"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...')",
+ "name": "constrainTo",
+ "type": "String/HTMLElement/Element",
+ "desc": "Constrain the resize to a particular element",
"memberOf": ""
},
{
- "name": "resizable",
- "type": "Boolean",
- "desc": "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
+ "name": "resizeRegion",
+ "type": "Roo.lib.Region",
+ "desc": "Constrain the resize to a particular region",
"memberOf": ""
},
{
- "name": "handleHeight",
- "type": "Number",
- "desc": "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
- "memberOf": ""
- },
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
{
- "name": "editable",
- "type": "Boolean",
- "desc": "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
- "memberOf": ""
+ "name": "beforeresize",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fired before resize is allowed. Set enabled to false to cancel resize."
},
{
- "name": "allQuery",
- "type": "String",
- "desc": "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
- "memberOf": ""
- },
+ "name": "resize",
+ "sig": "function (_self, width, height, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fired after a resize."
+ }
+ ]
+ },
+ "Roo.Shadow": {
+ "props": [
{
"name": "mode",
"type": "String",
- "desc": "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "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": ""
- },
- {
- "name": "forceSelection",
- "type": "Boolean",
- "desc": "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf": ""
- },
- {
- "name": "typeAheadDelay",
- "type": "Number",
- "desc": "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
+ "desc": "The shadow display mode. Supports the following options:<br />\nsides: Shadow displays on both sides and bottom only<br />\nframe: Shadow displays equally on all four sides<br />\ndrop: Traditional bottom-right drop shadow (default)",
"memberOf": ""
},
{
- "name": "valueNotFoundText",
+ "name": "offset",
"type": "String",
- "desc": "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
- "memberOf": ""
- },
- {
- "name": "blockFocus",
- "type": "bool",
- "desc": "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "desc": "The number of pixels to offset the shadow from the element (defaults to 4)",
"memberOf": ""
- },
+ }
+ ],
+ "events": []
+ },
+ "Roo.SplitBar": {
+ "props": [
{
- "name": "disableClear",
- "type": "bool",
- "desc": "Disable showing of clear button.",
- "memberOf": ""
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
"events": [
{
- "name": "beforequery",
- "sig": "function (combo, query, forceAll, cancel, e)\n{\n\n}",
- "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:"
- },
- {
- "name": "beforeselect",
- "sig": "function (combo, record, index)\n{\n\n}",
- "type": "function",
- "desc": "Fires before a list item is selected. Return false to cancel the selection."
- },
- {
- "name": "collapse",
- "sig": "function (combo)\n{\n\n}",
+ "name": "beforeresize",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the dropdown list is collapsed"
+ "desc": "Fires before the splitter is dragged"
},
{
- "name": "expand",
- "sig": "function (combo)\n{\n\n}",
+ "name": "moved",
+ "sig": "function (_self, newSize)\n{\n\n}",
"type": "function",
- "desc": "Fires when the dropdown list is expanded"
+ "desc": "Fires when the splitter is moved"
},
{
- "name": "select",
- "sig": "function (combo, record, index)\n{\n\n}",
+ "name": "resize",
+ "sig": "function (_self, newSize)\n{\n\n}",
"type": "function",
- "desc": "Fires when a list item is selected"
+ "desc": "Fires when the splitter is moved (alias for {@link #event-moved})"
}
]
},
- "Roo.form.DateField": {
+ "Roo.SplitBar.AbsoluteLayoutAdapter": {
+ "props": [],
+ "events": []
+ },
+ "Roo.SplitBar.BasicLayoutAdapter": {
+ "props": [],
+ "events": []
+ },
+ "Roo.SplitButton": {
"props": [
{
- "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').",
+ "name": "arrowHandler",
+ "type": "Function",
+ "desc": "A function called when the arrow button is clicked (can be used instead of click event)",
"memberOf": ""
},
{
- "name": "altFormats",
+ "name": "arrowTooltip",
"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').",
+ "desc": "The title attribute of the arrow",
"memberOf": ""
},
{
- "name": "disabledDays",
- "type": "Array",
- "desc": "An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).",
- "memberOf": ""
+ "name": "text",
+ "type": "String",
+ "desc": "The button text",
+ "memberOf": "Roo.Button"
},
{
- "name": "disabledDaysText",
+ "name": "icon",
"type": "String",
- "desc": "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')",
- "memberOf": ""
+ "desc": "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")",
+ "memberOf": "Roo.Button"
},
{
- "name": "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<ul>\n<li>[\"03/08/2003\", \"09/16/2003\"] would disable those exact dates</li>\n<li>[\"03/08\", \"09/16\"] would disable those days for every year</li>\n<li>[\"^03/08\"] would only match the beginning (useful if you are using short years)</li>\n<li>[\"03/../2006\"] would disable every day in March 2006</li>\n<li>[\"^03\"] would disable every day in every March</li>\n</ul>\nIn order to support regular expressions, if you are using a date format that has \".\" in it, you will have to\nescape the dot when restricting dates. For example: [\"03\\\\.08\\\\.03\"].",
- "memberOf": ""
+ "name": "handler",
+ "type": "Function",
+ "desc": "A function called when the button is clicked (can be used instead of click event)",
+ "memberOf": "Roo.Button"
},
{
- "name": "disabledDatesText",
- "type": "String",
- "desc": "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')",
- "memberOf": ""
- },
- {
- "name": "minValue",
- "type": "Date/String",
- "desc": "The minimum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
- "memberOf": ""
- },
- {
- "name": "maxValue",
- "type": "Date/String",
- "desc": "The maximum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
- "memberOf": ""
- },
- {
- "name": "minText",
- "type": "String",
- "desc": "The error text to display when the date in the cell is before minValue (defaults to\n'The date in this field must be after {minValue}').",
- "memberOf": ""
- },
- {
- "name": "maxText",
- "type": "String",
- "desc": "The error text to display when the date in the cell is after maxValue (defaults to\n'The date in this field must be before {maxValue}').",
- "memberOf": ""
+ "name": "scope",
+ "type": "Object",
+ "desc": "The scope of the handler",
+ "memberOf": "Roo.Button"
},
{
- "name": "invalidText",
- "type": "String",
- "desc": "The error text to display when the date in the field is invalid (defaults to\n'{value} is not a valid date - it must be in the format {format}').",
- "memberOf": ""
+ "name": "minWidth",
+ "type": "Number",
+ "desc": "The minimum width for this button (used to give a set of buttons a common width)",
+ "memberOf": "Roo.Button"
},
{
- "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 <b>appended</b> if specified (defaults to 'x-form-date-trigger'\nwhich displays a calendar icon).",
- "memberOf": ""
+ "name": "tooltip",
+ "type": "String/Object",
+ "desc": "The tooltip for the button - can be a string or QuickTips config object",
+ "memberOf": "Roo.Button"
},
{
- "name": "useIso",
- "type": "bool",
- "desc": "if enabled, then the date field will use a hidden field to store the \nreal value as iso formated date. default (false)",
- "memberOf": ""
+ "name": "hidden",
+ "type": "Boolean",
+ "desc": "True to start hidden (defaults to false)",
+ "memberOf": "Roo.Button"
},
{
- "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": ""
- }
- ],
- "events": [
- {
- "name": "select",
- "sig": "function (combo, date)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a date is selected"
- }
- ]
- },
- "Roo.form.FCKeditor": {
- "props": [
- {
- "name": "fck",
- "type": "Object",
- "desc": "options - see fck manual for details.",
- "memberOf": ""
- }
- ],
- "events": [
- {
- "name": "editorinit",
- "sig": "function (_self, the)\n{\n\n}",
- "type": "function",
- "desc": "Fired when the editor is initialized - you can add extra handlers here.."
- }
- ]
- },
- "Roo.form.Field": {
- "props": [
- {
- "name": "fieldLabel",
- "type": "String",
- "desc": "Label to use when rendering a form.",
- "memberOf": ""
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "True to start disabled (defaults to false)",
+ "memberOf": "Roo.Button"
},
{
- "name": "qtip",
- "type": "String",
- "desc": "Mouse over tip",
- "memberOf": ""
+ "name": "pressed",
+ "type": "Boolean",
+ "desc": "True to start pressed (only if enableToggle = true)",
+ "memberOf": "Roo.Button"
},
{
- "name": "name",
+ "name": "toggleGroup",
"type": "String",
- "desc": "The field's HTML name attribute.",
- "memberOf": ""
+ "desc": "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
+ "memberOf": "Roo.Button"
},
{
- "name": "invalidClass",
- "type": "String",
- "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf": ""
+ "name": "renderTo",
+ "type": "String/HTMLElement/Element",
+ "desc": "The element to append the button to",
+ "memberOf": "Roo.Button"
},
{
- "name": "invalidText",
- "type": "String",
- "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf": ""
+ "name": "repeat",
+ "type": "Boolean/Object",
+ "desc": "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).",
+ "memberOf": "Roo.Button"
},
{
- "name": "focusClass",
+ "name": "cls",
"type": "String",
- "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf": ""
+ "desc": "A CSS class to apply to the button's main element.",
+ "memberOf": "Roo.Button"
},
{
- "name": "validationEvent",
- "type": "String/Boolean",
- "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf": ""
+ "name": "tabIndex",
+ "type": "Number",
+ "desc": "The DOM tabIndex for this button (defaults to undefined)",
+ "memberOf": "Roo.Button"
},
{
- "name": "validateOnBlur",
+ "name": "enableToggle",
"type": "Boolean",
- "desc": "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf": ""
- },
- {
- "name": "validationDelay",
- "type": "Number",
- "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf": ""
+ "desc": "True to enable pressed/not pressed toggling (defaults to false)",
+ "memberOf": "Roo.Button"
},
{
- "name": "autoCreate",
- "type": "String/Object",
- "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
- "memberOf": ""
+ "name": "menu",
+ "type": "Mixed",
+ "desc": "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
+ "memberOf": "Roo.Button"
},
{
- "name": "fieldClass",
+ "name": "menuAlign",
"type": "String",
- "desc": "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf": ""
+ "desc": "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
+ "memberOf": "Roo.Button"
},
{
- "name": "msgTarget",
+ "name": "iconCls",
"type": "String",
- "desc": "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\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</pre>",
- "memberOf": ""
+ "desc": "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
+ "memberOf": "Roo.Button"
},
{
- "name": "msgFx",
+ "name": "type",
"type": "String",
- "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf": ""
+ "desc": "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
+ "memberOf": "Roo.Button"
},
{
- "name": "readOnly",
- "type": "Boolean",
- "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf": ""
+ "name": "clickEvent",
+ "type": "String",
+ "desc": "The type of event to map to the button's event handler (defaults to 'click')",
+ "memberOf": "Roo.Button"
},
{
- "name": "disabled",
+ "name": "handleMouseEvents",
"type": "Boolean",
- "desc": "True to disable the field (defaults to false).",
- "memberOf": ""
+ "desc": "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
+ "memberOf": "Roo.Button"
},
{
- "name": "inputType",
+ "name": "tooltipType",
"type": "String",
- "desc": "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "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": ""
+ "desc": "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
+ "memberOf": "Roo.Button"
},
{
- "name": "value",
- "type": "Mixed",
- "desc": "A value to initialize this field with.",
- "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"
},
{
- "name": "cls",
- "type": "String",
- "desc": "A CSS class to apply to the field's underlying element.",
- "memberOf": ""
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
"events": [
{
- "name": "blur",
- "sig": "function (_self)\n{\n\n}",
+ "name": "arrowclick",
+ "sig": "function (_self, e)\n{\n\n}",
"type": "function",
- "desc": "Fires when this field loses input focus."
+ "desc": "Fires when this button's arrow is clicked"
},
{
- "name": "change",
- "sig": "function (_self, newValue, oldValue)\n{\n\n}",
+ "name": "click",
+ "sig": "function (_self, e)\n{\n\n}",
"type": "function",
- "desc": "Fires just before the field blurs if the field value has changed."
+ "desc": "Fires when this button is clicked"
},
{
- "name": "focus",
- "sig": "function (_self)\n{\n\n}",
+ "name": "mouseout",
+ "sig": "function (_self, e)\n{\n\n}",
"type": "function",
- "desc": "Fires when this field receives input focus."
+ "desc": "Fires when the mouse exits the button"
},
{
- "name": "invalid",
- "sig": "function (_self, msg)\n{\n\n}",
+ "name": "mouseover",
+ "sig": "function (_self, e)\n{\n\n}",
"type": "function",
- "desc": "Fires after the field has been marked as invalid."
+ "desc": "Fires when the mouse hovers over the button"
},
{
- "name": "specialkey",
- "sig": "function (_self, e)\n{\n\n}",
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
"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."
+ "desc": "Fires when the button is rendered"
},
{
- "name": "valid",
- "sig": "function (_self)\n{\n\n}",
+ "name": "toggle",
+ "sig": "function (_self, pressed)\n{\n\n}",
"type": "function",
- "desc": "Fires after the field has been validated with no errors."
+ "desc": "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)"
}
]
},
- "Roo.form.FieldSet": {
+ "Roo.SplitLayoutRegion": {
"props": [
{
- "name": "legend",
- "type": "String",
- "desc": "The text to display as the legend for the FieldSet (defaults to '')",
- "memberOf": ""
+ "name": "collapsible",
+ "type": "Boolean",
+ "desc": "False to disable collapsing (defaults to true)",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "autoCreate",
- "type": "String/Object",
- "desc": "A DomHelper element spec used to autocreate the fieldset (defaults to {tag: 'fieldset', cn: {tag:'legend'}})",
- "memberOf": ""
- }
- ],
- "events": []
- },
- "Roo.form.Form": {
- "props": [
- {
- "name": "labelWidth",
- "type": "Number",
- "desc": "The width of labels. This property cascades to child containers.",
- "memberOf": ""
+ "name": "collapsed",
+ "type": "Boolean",
+ "desc": "True to set the initial display to collapsed (defaults to false)",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "itemCls",
+ "name": "floatable",
+ "type": "Boolean",
+ "desc": "False to disable floating (defaults to true)",
+ "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"
+ },
+ {
+ "name": "cmargins",
+ "type": "Object",
+ "desc": "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "tabPosition",
"type": "String",
- "desc": "A css class to apply to the x-form-item of fields. This property cascades to child containers.",
- "memberOf": ""
+ "desc": "\"top\" or \"bottom\" (defaults to \"bottom\")",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "buttonAlign",
+ "name": "collapsedTitle",
"type": "String",
- "desc": "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"center\")",
- "memberOf": ""
+ "desc": "Optional string message to display in the collapsed block of a north or south region",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "minButtonWidth",
- "type": "Number",
- "desc": "Minimum width of all buttons in pixels (defaults to 75)",
- "memberOf": ""
+ "name": "alwaysShowTabs",
+ "type": "Boolean",
+ "desc": "True to always display tabs even when there is only 1 panel (defaults to false)",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "labelAlign",
+ "name": "autoScroll",
+ "type": "Boolean",
+ "desc": "True to enable overflow scrolling (defaults to false)",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "titlebar",
+ "type": "Boolean",
+ "desc": "True to display a title bar (defaults to true)",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "title",
"type": "String",
- "desc": "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\").\nThis property cascades to child containers if not set.",
- "memberOf": ""
+ "desc": "The title for the region (overrides panel titles)",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "monitorValid",
+ "name": "animate",
"type": "Boolean",
- "desc": "If true the form monitors its valid state <b>client-side</b> 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": ""
+ "desc": "True to animate expand/collapse (defaults to false)",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "monitorPoll",
+ "name": "autoHide",
+ "type": "Boolean",
+ "desc": "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "preservePanels",
+ "type": "Boolean",
+ "desc": "True to preserve removed panels so they can be readded later (defaults to false)",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "closeOnTab",
+ "type": "Boolean",
+ "desc": "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "hideTabs",
+ "type": "Boolean",
+ "desc": "True to hide the tab strip (defaults to false)",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "resizeTabs",
+ "type": "Boolean",
+ "desc": "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "minTabWidth",
"type": "Number",
- "desc": "The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)",
- "memberOf": ""
- }
- ],
- "events": [
+ "desc": "The minimum tab width (defaults to 40)",
+ "memberOf": "Roo.LayoutRegion"
+ },
{
- "name": "clientvalidation",
- "sig": "function (_self, valid)\n{\n\n}",
- "type": "function",
- "desc": "If the monitorValid config option is true, this event fires repetitively to notify of valid state"
+ "name": "preferredTabWidth",
+ "type": "Number",
+ "desc": "The preferred tab width (defaults to 150)",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "rendered",
- "sig": "function (form)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the form is rendered"
- }
- ]
- },
- "Roo.form.GridField": {
- "props": [
+ "name": "showPin",
+ "type": "Boolean",
+ "desc": "True to show a pin button",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "hidden",
+ "type": "Boolean",
+ "desc": "True to start the region hidden (defaults to false)",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "hideWhenEmpty",
+ "type": "Boolean",
+ "desc": "True to hide the region when it has no panels",
+ "memberOf": "Roo.LayoutRegion"
+ },
+ {
+ "name": "disableTabTips",
+ "type": "Boolean",
+ "desc": "True to disable tab tooltips",
+ "memberOf": "Roo.LayoutRegion"
+ },
{
"name": "width",
"type": "Number",
- "desc": "- used to restrict width of grid..",
- "memberOf": ""
+ "desc": "For East/West panels",
+ "memberOf": "Roo.LayoutRegion"
},
{
"name": "height",
"type": "Number",
- "desc": "- used to restrict height of grid..",
- "memberOf": ""
+ "desc": "For North/South panels",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "xgrid",
- "type": "Object",
- "desc": "(xtype'd description of grid) Grid or EditorGrid",
- "memberOf": ""
+ "name": "split",
+ "type": "Boolean",
+ "desc": "To show the splitter",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "autoCreate",
- "type": "String/Object",
- "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
- "memberOf": ""
+ "name": "toolbar",
+ "type": "Boolean",
+ "desc": "xtype configuration for a toolbar - shows on right of tabbar",
+ "memberOf": "Roo.LayoutRegion"
},
{
- "name": "addTitle",
- "type": "String",
- "desc": "Text to include for adding a title.",
- "memberOf": ""
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
- "events": []
- },
- "Roo.form.Hidden": {
- "props": [],
- "events": []
- },
- "Roo.form.HtmlEditor": {
- "props": [
+ "events": [
{
- "name": "toolbars",
- "type": "Array",
- "desc": "Array of toolbars. - defaults to just the Standard one",
- "memberOf": ""
+ "name": "beforeremove",
+ "sig": "function (_self, panel, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument."
},
{
- "name": "createLinkText",
- "type": "String",
- "desc": "The default text for the create link prompt",
- "memberOf": ""
+ "name": "collapsed",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this region is collapsed."
},
{
- "name": "defaultLinkValue",
- "type": "String",
- "desc": "The default value for the create link prompt (defaults to http:/ /)",
- "memberOf": ""
- }
- ],
- "events": [
+ "name": "expanded",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this region is expanded."
+ },
{
- "name": "activate",
+ "name": "invalidated",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event."
+ "desc": "Fires when the layout for this region is changed."
},
{
- "name": "beforepush",
- "sig": "function (_self, html)\n{\n\n}",
+ "name": "panelactivated",
+ "sig": "function (_self, panel)\n{\n\n}",
"type": "function",
- "desc": "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push."
+ "desc": "Fires when a panel is activated."
},
{
- "name": "beforesync",
- "sig": "function (_self, html)\n{\n\n}",
+ "name": "paneladded",
+ "sig": "function (_self, panel)\n{\n\n}",
"type": "function",
- "desc": "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync."
+ "desc": "Fires when a panel is added."
},
{
- "name": "editmodechange",
- "sig": "function (_self, sourceEdit)\n{\n\n}",
+ "name": "panelremoved",
+ "sig": "function (_self, panel)\n{\n\n}",
"type": "function",
- "desc": "Fires when the editor switches edit modes"
+ "desc": "Fires when a panel is removed."
},
{
- "name": "editorevent",
- "sig": "function (_self)\n{\n\n}",
+ "name": "resized",
+ "sig": "function (_self, newSize)\n{\n\n}",
"type": "function",
- "desc": "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks."
+ "desc": "Fires when the user resizes this region."
},
{
- "name": "initialize",
+ "name": "slidehide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the editor is fully initialized (including the iframe)"
+ "desc": "Fires when this region slides out of view."
},
{
- "name": "push",
- "sig": "function (_self, html)\n{\n\n}",
+ "name": "slideshow",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the iframe editor is updated with content from the textarea."
+ "desc": "Fires when this region is slid into view."
},
{
- "name": "sync",
- "sig": "function (_self, html)\n{\n\n}",
+ "name": "visibilitychange",
+ "sig": "function (_self, visibility)\n{\n\n}",
"type": "function",
- "desc": "Fires when the textarea is updated with content from the editor iframe."
+ "desc": "Fires when this region is shown or hidden"
}
]
},
- "Roo.form.HtmlEditor.ToolbarContext": {
+ "Roo.TabPanel": {
"props": [
{
- "name": "disable",
+ "name": "listeners",
"type": "Object",
- "desc": "List of toolbar elements to disable",
- "memberOf": ""
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
- "events": []
- },
- "Roo.form.HtmlEditor.ToolbarStandard": {
- "props": [
+ "events": [
{
- "name": "disable",
- "type": "Object",
- "desc": "List of elements to disable..",
- "memberOf": ""
+ "name": "beforetabchange",
+ "sig": "function (_self, e, tab)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change"
},
{
- "name": "btns",
- "type": "Array",
- "desc": "List of additional buttons.\n\n\nNEEDS Extra CSS? \n.x-html-editor-tb .x-edit-none .x-btn-text { background: none; }",
- "memberOf": ""
+ "name": "tabchange",
+ "sig": "function (_self, activePanel)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the active tab changes"
+ }
+ ]
+ },
+ "Roo.TabPanelItem": {
+ "props": [
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "activate",
+ "sig": "function (tabPanel, _self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this tab becomes the active tab."
},
{
- "name": "fontFamilies",
- "type": "Array",
- "desc": "An array of available font families",
- "memberOf": ""
+ "name": "beforeclose",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true)."
},
{
- "name": "defaultFont",
+ "name": "close",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this tab is closed."
+ },
+ {
+ "name": "deactivate",
+ "sig": "function (tabPanel, _self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this tab is no longer the active tab."
+ }
+ ]
+ },
+ "Roo.Template": {
+ "props": [
+ {
+ "name": "html",
"type": "String",
- "desc": "default font to use.",
+ "desc": "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")",
"memberOf": ""
}
],
"events": []
},
- "Roo.form.Layout": {
+ "Roo.Toolbar": {
"props": [
{
- "name": "autoCreate",
- "type": "String/Object",
- "desc": "A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'})",
+ "name": "items",
+ "type": "Array",
+ "desc": "array of button configs or elements to add (will be converted to a MixedCollection)",
"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.",
+ "name": "container",
+ "type": "String/HTMLElement/Element",
+ "desc": "The id or element that will contain the toolbar",
"memberOf": ""
+ }
+ ],
+ "events": []
+ },
+ "Roo.Toolbar.Button": {
+ "props": [
+ {
+ "name": "text",
+ "type": "String",
+ "desc": "The button text",
+ "memberOf": "Roo.Button"
},
{
- "name": "labelAlign",
+ "name": "icon",
"type": "String",
- "desc": "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
- "memberOf": ""
+ "desc": "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")",
+ "memberOf": "Roo.Button"
},
{
- "name": "labelWidth",
+ "name": "handler",
+ "type": "Function",
+ "desc": "A function called when the button is clicked (can be used instead of click event)",
+ "memberOf": "Roo.Button"
+ },
+ {
+ "name": "scope",
+ "type": "Object",
+ "desc": "The scope of the handler",
+ "memberOf": "Roo.Button"
+ },
+ {
+ "name": "minWidth",
"type": "Number",
- "desc": "Fixed width in pixels of all field labels (defaults to undefined)",
- "memberOf": ""
+ "desc": "The minimum width for this button (used to give a set of buttons a common width)",
+ "memberOf": "Roo.Button"
},
{
- "name": "clear",
+ "name": "tooltip",
+ "type": "String/Object",
+ "desc": "The tooltip for the button - can be a string or QuickTips config object",
+ "memberOf": "Roo.Button"
+ },
+ {
+ "name": "hidden",
"type": "Boolean",
- "desc": "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
- "memberOf": ""
+ "desc": "True to start hidden (defaults to false)",
+ "memberOf": "Roo.Button"
},
{
- "name": "labelSeparator",
- "type": "String",
- "desc": "The separator to use after field labels (defaults to ':')",
- "memberOf": ""
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "True to start disabled (defaults to false)",
+ "memberOf": "Roo.Button"
},
{
- "name": "hideLabels",
+ "name": "pressed",
"type": "Boolean",
- "desc": "True to suppress the display of field labels in this layout (defaults to false)",
- "memberOf": ""
- }
- ],
- "events": []
- },
- "Roo.form.NumberField": {
- "props": [
+ "desc": "True to start pressed (only if enableToggle = true)",
+ "memberOf": "Roo.Button"
+ },
{
- "name": "fieldClass",
+ "name": "toggleGroup",
"type": "String",
- "desc": "The default CSS class for the field (defaults to \"x-form-field x-form-num-field\")",
- "memberOf": ""
+ "desc": "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
+ "memberOf": "Roo.Button"
},
{
- "name": "allowDecimals",
- "type": "Boolean",
- "desc": "False to disallow decimal values (defaults to true)",
- "memberOf": ""
+ "name": "renderTo",
+ "type": "String/HTMLElement/Element",
+ "desc": "The element to append the button to",
+ "memberOf": "Roo.Button"
},
{
- "name": "decimalSeparator",
+ "name": "repeat",
+ "type": "Boolean/Object",
+ "desc": "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).",
+ "memberOf": "Roo.Button"
+ },
+ {
+ "name": "cls",
"type": "String",
- "desc": "Character(s) to allow as the decimal separator (defaults to '.')",
- "memberOf": ""
+ "desc": "A CSS class to apply to the button's main element.",
+ "memberOf": "Roo.Button"
},
{
- "name": "decimalPrecision",
+ "name": "tabIndex",
"type": "Number",
- "desc": "The maximum precision to display after the decimal separator (defaults to 2)",
- "memberOf": ""
+ "desc": "The DOM tabIndex for this button (defaults to undefined)",
+ "memberOf": "Roo.Button"
},
{
- "name": "allowNegative",
+ "name": "enableToggle",
"type": "Boolean",
- "desc": "False to prevent entering a negative sign (defaults to true)",
- "memberOf": ""
+ "desc": "True to enable pressed/not pressed toggling (defaults to false)",
+ "memberOf": "Roo.Button"
},
{
- "name": "minValue",
- "type": "Number",
- "desc": "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
- "memberOf": ""
+ "name": "menu",
+ "type": "Mixed",
+ "desc": "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
+ "memberOf": "Roo.Button"
},
{
- "name": "maxValue",
- "type": "Number",
- "desc": "The maximum allowed value (defaults to Number.MAX_VALUE)",
- "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"
},
{
- "name": "minText",
+ "name": "iconCls",
"type": "String",
- "desc": "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")",
- "memberOf": ""
+ "desc": "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
+ "memberOf": "Roo.Button"
},
{
- "name": "maxText",
+ "name": "type",
"type": "String",
- "desc": "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")",
- "memberOf": ""
+ "desc": "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
+ "memberOf": "Roo.Button"
},
{
- "name": "nanText",
+ "name": "clickEvent",
"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": ""
- }
- ],
- "events": []
- },
- "Roo.form.Radio": {
- "props": [],
- "events": []
- },
- "Roo.form.Row": {
- "props": [
- {
- "name": "width",
- "type": "Number/String",
- "desc": "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
- "memberOf": ""
+ "desc": "The type of event to map to the button's event handler (defaults to 'click')",
+ "memberOf": "Roo.Button"
},
{
- "name": "height",
- "type": "Number/String",
- "desc": "The fixed height of the column in pixels or CSS value (defaults to \"auto\")",
- "memberOf": ""
- }
- ],
- "events": []
- },
- "Roo.form.TextArea": {
- "props": [
- {
- "name": "growMin",
- "type": "Number",
- "desc": "The minimum height to allow when grow = true (defaults to 60)",
- "memberOf": ""
+ "name": "handleMouseEvents",
+ "type": "Boolean",
+ "desc": "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
+ "memberOf": "Roo.Button"
},
{
- "name": "growMax",
- "type": "Number",
- "desc": "The maximum height to allow when grow = true (defaults to 1000)",
- "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"
},
{
- "name": "preventScrollbars",
- "type": "Boolean",
- "desc": "True to prevent scrollbars from appearing regardless of how much text is\nin the field (equivalent to setting overflow: hidden, defaults to false)",
- "memberOf": ""
+ "name": "template",
+ "type": "Roo.Template",
+ "desc": "(Optional)\nAn {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.",
+ "memberOf": "Roo.Button"
},
{
- "name": "autoCreate",
- "type": "String/Object",
- "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"textarea\", style: \"width:300px;height:60px;\", autocomplete: \"off\"})",
- "memberOf": ""
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
- "events": []
- },
- "Roo.form.TextField": {
- "props": [
+ "events": [
{
- "name": "grow",
- "type": "Boolean",
- "desc": "True if this field should automatically grow and shrink to its content",
- "memberOf": ""
+ "name": "click",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this button is clicked"
},
{
- "name": "growMin",
- "type": "Number",
- "desc": "The minimum width to allow when grow = true (defaults to 30)",
- "memberOf": ""
+ "name": "mouseout",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the mouse exits the button"
},
{
- "name": "growMax",
- "type": "Number",
- "desc": "The maximum width to allow when grow = true (defaults to 800)",
- "memberOf": ""
+ "name": "mouseover",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the mouse hovers over the button"
},
{
- "name": "vtype",
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the button is rendered"
+ },
+ {
+ "name": "toggle",
+ "sig": "function (_self, pressed)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)"
+ }
+ ]
+ },
+ "Roo.Toolbar.Fill": {
+ "props": [],
+ "events": []
+ },
+ "Roo.Toolbar.Item": {
+ "props": [],
+ "events": []
+ },
+ "Roo.Toolbar.Separator": {
+ "props": [],
+ "events": []
+ },
+ "Roo.Toolbar.Spacer": {
+ "props": [],
+ "events": []
+ },
+ "Roo.Toolbar.SplitButton": {
+ "props": [
+ {
+ "name": "arrowHandler",
+ "type": "Function",
+ "desc": "A function called when the arrow button is clicked (can be used instead of click event)",
+ "memberOf": "Roo.SplitButton"
+ },
+ {
+ "name": "arrowTooltip",
"type": "String",
- "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf": ""
+ "desc": "The title attribute of the arrow",
+ "memberOf": "Roo.SplitButton"
},
{
- "name": "maskRe",
+ "name": "text",
"type": "String",
- "desc": "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf": ""
+ "desc": "The button text",
+ "memberOf": "Roo.Button"
},
{
- "name": "disableKeyFilter",
- "type": "Boolean",
- "desc": "True to disable input keystroke filtering (defaults to false)",
- "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"
},
{
- "name": "allowBlank",
- "type": "Boolean",
- "desc": "False to validate that the value length > 0 (defaults to true)",
- "memberOf": ""
+ "name": "handler",
+ "type": "Function",
+ "desc": "A function called when the button is clicked (can be used instead of click event)",
+ "memberOf": "Roo.Button"
},
{
- "name": "minLength",
- "type": "Number",
- "desc": "Minimum input field length required (defaults to 0)",
- "memberOf": ""
+ "name": "scope",
+ "type": "Object",
+ "desc": "The scope of the handler",
+ "memberOf": "Roo.Button"
},
{
- "name": "maxLength",
+ "name": "minWidth",
"type": "Number",
- "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf": ""
+ "desc": "The minimum width for this button (used to give a set of buttons a common width)",
+ "memberOf": "Roo.Button"
},
{
- "name": "minLengthText",
+ "name": "tooltip",
+ "type": "String/Object",
+ "desc": "The tooltip for the button - can be a string or QuickTips config object",
+ "memberOf": "Roo.Button"
+ },
+ {
+ "name": "hidden",
+ "type": "Boolean",
+ "desc": "True to start hidden (defaults to false)",
+ "memberOf": "Roo.Button"
+ },
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "True to start disabled (defaults to false)",
+ "memberOf": "Roo.Button"
+ },
+ {
+ "name": "pressed",
+ "type": "Boolean",
+ "desc": "True to start pressed (only if enableToggle = true)",
+ "memberOf": "Roo.Button"
+ },
+ {
+ "name": "toggleGroup",
"type": "String",
- "desc": "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf": ""
+ "desc": "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
+ "memberOf": "Roo.Button"
},
{
- "name": "maxLengthText",
+ "name": "renderTo",
+ "type": "String/HTMLElement/Element",
+ "desc": "The element to append the button to",
+ "memberOf": "Roo.Button"
+ },
+ {
+ "name": "repeat",
+ "type": "Boolean/Object",
+ "desc": "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).",
+ "memberOf": "Roo.Button"
+ },
+ {
+ "name": "cls",
"type": "String",
- "desc": "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf": ""
+ "desc": "A CSS class to apply to the button's main element.",
+ "memberOf": "Roo.Button"
},
{
- "name": "selectOnFocus",
+ "name": "tabIndex",
+ "type": "Number",
+ "desc": "The DOM tabIndex for this button (defaults to undefined)",
+ "memberOf": "Roo.Button"
+ },
+ {
+ "name": "enableToggle",
"type": "Boolean",
- "desc": "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf": ""
+ "desc": "True to enable pressed/not pressed toggling (defaults to false)",
+ "memberOf": "Roo.Button"
},
{
- "name": "blankText",
- "type": "String",
- "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf": ""
+ "name": "menu",
+ "type": "Mixed",
+ "desc": "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
+ "memberOf": "Roo.Button"
},
{
- "name": "validator",
- "type": "Function",
- "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf": ""
+ "name": "menuAlign",
+ "type": "String",
+ "desc": "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
+ "memberOf": "Roo.Button"
},
{
- "name": "regex",
- "type": "RegExp",
- "desc": "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf": ""
+ "name": "iconCls",
+ "type": "String",
+ "desc": "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
+ "memberOf": "Roo.Button"
},
{
- "name": "regexText",
+ "name": "type",
"type": "String",
- "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf": ""
+ "desc": "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
+ "memberOf": "Roo.Button"
},
{
- "name": "emptyText",
+ "name": "clickEvent",
"type": "String",
- "desc": "The default text to display in an empty field (defaults to null).",
- "memberOf": ""
+ "desc": "The type of event to map to the button's event handler (defaults to 'click')",
+ "memberOf": "Roo.Button"
},
{
- "name": "emptyClass",
+ "name": "handleMouseEvents",
+ "type": "Boolean",
+ "desc": "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
+ "memberOf": "Roo.Button"
+ },
+ {
+ "name": "tooltipType",
"type": "String",
- "desc": "The CSS class to apply to an empty field to style the {@link #emptyText} (defaults to\n'x-form-empty-field'). This class is automatically added and removed as needed depending on the current field value.",
- "memberOf": ""
+ "desc": "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
+ "memberOf": "Roo.Button"
+ },
+ {
+ "name": "template",
+ "type": "Roo.Template",
+ "desc": "(Optional)\nAn {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.",
+ "memberOf": "Roo.Button"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
"events": [
{
- "name": "autosize",
- "sig": "function (_self, width)\n{\n\n}",
+ "name": "arrowclick",
+ "sig": "function (_self, e)\n{\n\n}",
"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."
+ "desc": "Fires when this button's arrow is clicked"
+ },
+ {
+ "name": "click",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this button is clicked"
+ },
+ {
+ "name": "mouseout",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the mouse exits the button"
+ },
+ {
+ "name": "mouseover",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the mouse hovers over the button"
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the button is rendered"
+ },
+ {
+ "name": "toggle",
+ "sig": "function (_self, pressed)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the \"pressed\" state of this button changes (only if enableToggle = true)"
}
]
},
- "Roo.form.TriggerField": {
+ "Roo.Toolbar.TextItem": {
+ "props": [],
+ "events": []
+ },
+ "Roo.TreePanel": {
"props": [
{
- "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 <b>appended</b> if specified.",
+ "name": "tree",
+ "type": "Roo.tree.TreePanel",
+ "desc": "The tree TreePanel, with config etc.",
"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"
+ },
+ {
+ "name": "fitContainer",
+ "type": "Boolean",
+ "desc": "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
+ "memberOf": "Roo.ContentPanel"
+ },
{
"name": "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": ""
+ "type": "Boolean/Object",
+ "desc": "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
+ "memberOf": "Roo.ContentPanel"
},
{
- "name": "hideTrigger",
+ "name": "closable",
"type": "Boolean",
- "desc": "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf": ""
- }
- ],
- "events": []
- },
- "Roo.form.VTypes": {
- "props": [],
- "events": []
+ "desc": "True if the panel can be closed/removed",
+ "memberOf": "Roo.ContentPanel"
+ },
+ {
+ "name": "background",
+ "type": "Boolean",
+ "desc": "True if the panel should not be activated when it is added (defaults to false)",
+ "memberOf": "Roo.ContentPanel"
+ },
+ {
+ "name": "resizeEl",
+ "type": "String/HTMLElement/Element",
+ "desc": "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
+ "memberOf": "Roo.ContentPanel"
+ },
+ {
+ "name": "toolbar",
+ "type": "Toolbar",
+ "desc": "A toolbar for this panel",
+ "memberOf": "Roo.ContentPanel"
+ },
+ {
+ "name": "autoScroll",
+ "type": "Boolean",
+ "desc": "True to scroll overflow in this panel (use with {@link #fitToFrame})",
+ "memberOf": "Roo.ContentPanel"
+ },
+ {
+ "name": "title",
+ "type": "String",
+ "desc": "The title for this panel",
+ "memberOf": "Roo.ContentPanel"
+ },
+ {
+ "name": "adjustments",
+ "type": "Array",
+ "desc": "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
+ "memberOf": "Roo.ContentPanel"
+ },
+ {
+ "name": "url",
+ "type": "String",
+ "desc": "Calls {@link #setUrl} with this value",
+ "memberOf": "Roo.ContentPanel"
+ },
+ {
+ "name": "region",
+ "type": "String",
+ "desc": "(center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
+ "memberOf": "Roo.ContentPanel"
+ },
+ {
+ "name": "params",
+ "type": "String/Object",
+ "desc": "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf": "Roo.ContentPanel"
+ },
+ {
+ "name": "loadOnce",
+ "type": "Boolean",
+ "desc": "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf": "Roo.ContentPanel"
+ },
+ {
+ "name": "content",
+ "type": "String",
+ "desc": "Raw content to fill content panel with (uses setContent on construction.)",
+ "memberOf": "Roo.ContentPanel"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "activate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this panel is activated."
+ },
+ {
+ "name": "deactivate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this panel is activated."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this tab is created"
+ },
+ {
+ "name": "resize",
+ "sig": "function (_self, width, height)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this panel is resized if fitToFrame is true."
+ }
+ ]
},
- "Roo.grid": {
- "props": [],
- "events": []
+ "Roo.UpdateManager": {
+ "props": [
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforeupdate",
+ "sig": "function (el, url, params)\n{\n\n}",
+ "type": "function",
+ "desc": "Fired before an update is made, return false from your handler and the update is cancelled."
+ },
+ {
+ "name": "failure",
+ "sig": "function (el, oResponseObject)\n{\n\n}",
+ "type": "function",
+ "desc": "Fired on update failure."
+ },
+ {
+ "name": "update",
+ "sig": "function (el, oResponseObject)\n{\n\n}",
+ "type": "function",
+ "desc": "Fired after successful update is made."
+ }
+ ]
},
- "Roo.grid.AbstractGridView": {
+ "Roo.UpdateManager.BasicRenderer": {
"props": [],
"events": []
},
- "Roo.grid.AbstractSelectionModel": {
+ "Roo.UpdateManager.defaults": {
"props": [],
"events": []
},
- "Roo.grid.CellSelectionModel": {
- "props": [],
+ "Roo.View": {
+ "props": [
+ {
+ "name": "store",
+ "type": "Roo.data.Store",
+ "desc": "Data store to load data from.",
+ "memberOf": ""
+ },
+ {
+ "name": "el",
+ "type": "String|Roo.Element",
+ "desc": "The container element.",
+ "memberOf": ""
+ },
+ {
+ "name": "tpl",
+ "type": "String|Roo.Template",
+ "desc": "The template used by this View",
+ "memberOf": ""
+ },
+ {
+ "name": "selectedClass",
+ "type": "String",
+ "desc": "The css class to add to selected nodes",
+ "memberOf": ""
+ },
+ {
+ "name": "emptyText",
+ "type": "String",
+ "desc": "The empty text to show when nothing is loaded.",
+ "memberOf": ""
+ },
+ {
+ "name": "multiSelect",
+ "type": "Boolean",
+ "desc": "Allow multiple selection",
+ "memberOf": ""
+ },
+ {
+ "name": "singleSelect",
+ "type": "Boolean",
+ "desc": "Allow single selection",
+ "memberOf": ""
+ },
+ {
+ "name": "toggleSelect",
+ "type": "Boolean",
+ "desc": "- selecting",
+ "memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforeclick",
+ "sig": "function (_self, index, node, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a click is processed. Returns false to cancel the default action."
+ },
+ {
+ "name": "beforeselect",
+ "sig": "function (_self, node, selections)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a selection is made. If any handlers return false, the selection is cancelled."
+ },
+ {
+ "name": "click",
+ "sig": "function (_self, index, node, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a template node is clicked."
+ },
+ {
+ "name": "contextmenu",
+ "sig": "function (_self, index, node, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a template node is right clicked."
+ },
+ {
+ "name": "dblclick",
+ "sig": "function (_self, index, node, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a template node is double clicked."
+ },
+ {
+ "name": "preparedata",
+ "sig": "function (_self, data)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires on every row to render, to allow you to change the data."
+ },
+ {
+ "name": "selectionchange",
+ "sig": "function (_self, selections)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the selected nodes change."
+ }
+ ]
+ },
+ "Roo.XComponent": {
+ "props": [
+ {
+ "name": "disabled",
+ "type": "Function|boolean",
+ "desc": "If this module is disabled by some rule, return true from the funtion",
+ "memberOf": ""
+ },
+ {
+ "name": "parent",
+ "type": "String",
+ "desc": "Name of parent element which it get xtype added to..",
+ "memberOf": ""
+ },
+ {
+ "name": "order",
+ "type": "String",
+ "desc": "Used to set the order in which elements are created (usefull for multiple tabs)",
+ "memberOf": ""
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "desc": "String to display while loading.",
+ "memberOf": ""
+ },
+ {
+ "name": "region",
+ "type": "String",
+ "desc": "Region to render component to (defaults to center)",
+ "memberOf": ""
+ },
+ {
+ "name": "items",
+ "type": "Array",
+ "desc": "A single item array - the first element is the root of the tree..\nIt's done this way to stay compatible with the Xtype system...",
+ "memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
"events": [
{
- "name": "beforerowselect",
- "sig": "function (_self, rowIndex, colIndex)\n{\n\n}",
+ "name": "buildcomplete",
+ "sig": "function (c)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires on the top level element when all elements have been built"
+ },
+ {
+ "name": "built",
+ "sig": "function (c)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this the componnt is built"
+ }
+ ]
+ },
+ "Roo.data": {
+ "props": [],
+ "events": []
+ },
+ "Roo.data.ArrayReader": {
+ "props": [
+ {
+ "name": "id",
+ "type": "String",
+ "desc": "(optional) The subscript within row Array that provides an ID for the Record",
+ "memberOf": ""
+ }
+ ],
+ "events": []
+ },
+ "Roo.data.Connection": {
+ "props": [
+ {
+ "name": "url",
+ "type": "String",
+ "desc": "(Optional) The default URL to be used for requests to the server. (defaults to undefined)",
+ "memberOf": ""
+ },
+ {
+ "name": "extraParams",
+ "type": "Object",
+ "desc": "(Optional) An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
+ "memberOf": ""
+ },
+ {
+ "name": "defaultHeaders",
+ "type": "Object",
+ "desc": "(Optional) An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
+ "memberOf": ""
+ },
+ {
+ "name": "method",
+ "type": "String",
+ "desc": "(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)",
+ "memberOf": ""
+ },
+ {
+ "name": "timeout",
+ "type": "Number",
+ "desc": "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
+ "memberOf": ""
+ },
+ {
+ "name": "autoAbort",
+ "type": "Boolean",
+ "desc": "(Optional) Whether this request should abort any pending requests. (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "disableCaching",
+ "type": "Boolean",
+ "desc": "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
+ "memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforerequest",
+ "sig": "function (conn, options)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a network request is made to retrieve a data object."
+ },
+ {
+ "name": "requestcomplete",
+ "sig": "function (conn, response, options)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires if the request was successfully completed."
+ },
+ {
+ "name": "requestexception",
+ "sig": "function (conn, response, options)\n{\n\n}",
+ "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."
+ }
+ ]
+ },
+ "Roo.data.DataProxy": {
+ "props": [],
+ "events": [
+ {
+ "name": "beforeload",
+ "sig": "function (This, params)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a network request is made to retrieve a data object."
+ },
+ {
+ "name": "load",
+ "sig": "function (This, o, arg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the load method's callback is called."
+ },
+ {
+ "name": "loadexception",
+ "sig": "function (This, o, arg, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires if an Exception occurs during data retrieval."
+ }
+ ]
+ },
+ "Roo.data.DataReader": {
+ "props": [],
+ "events": []
+ },
+ "Roo.data.HttpProxy": {
+ "props": [
+ {
+ "name": "url",
+ "type": "String",
+ "desc": "(Optional) The default URL to be used for requests to the server. (defaults to undefined)",
+ "memberOf": ""
+ },
+ {
+ "name": "extraParams",
+ "type": "Object",
+ "desc": "(Optional) An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
+ "memberOf": ""
+ },
+ {
+ "name": "defaultHeaders",
+ "type": "Object",
+ "desc": "(Optional) An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
+ "memberOf": ""
+ },
+ {
+ "name": "method",
+ "type": "String",
+ "desc": "(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)",
+ "memberOf": ""
+ },
+ {
+ "name": "timeout",
+ "type": "Number",
+ "desc": "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
+ "memberOf": ""
+ },
+ {
+ "name": "autoAbort",
+ "type": "Boolean",
+ "desc": "(Optional) Whether this request should abort any pending requests. (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "disableCaching",
+ "type": "Boolean",
+ "desc": "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
+ "memberOf": ""
+ }
+ ],
+ "events": [
+ {
+ "name": "beforeload",
+ "sig": "function (This, params)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a network request is made to retrieve a data object."
+ },
+ {
+ "name": "load",
+ "sig": "function (This, o, arg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the load method's callback is called."
+ },
+ {
+ "name": "loadexception",
+ "sig": "function (This, o, arg, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires if an Exception occurs during data retrieval."
+ }
+ ]
+ },
+ "Roo.data.JsonReader": {
+ "props": [
+ {
+ "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": ""
+ },
+ {
+ "name": "successProperty",
+ "type": "String",
+ "desc": "Name of the property from which to retrieve the success attribute used by forms.",
+ "memberOf": ""
+ },
+ {
+ "name": "root",
+ "type": "String",
+ "desc": "name of the property which contains the Array of row objects.",
+ "memberOf": ""
+ },
+ {
+ "name": "id",
+ "type": "String",
+ "desc": "Name of the property within a row object that contains a record identifier value.",
+ "memberOf": ""
+ }
+ ],
+ "events": []
+ },
+ "Roo.data.JsonStore": {
+ "props": [
+ {
+ "name": "fields",
+ "type": "Array",
+ "desc": "An array of field definition objects, or field name strings.",
+ "memberOf": ""
+ },
+ {
+ "name": "isLocal",
+ "type": "boolean",
+ "desc": "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
+ "memberOf": "Roo.data.Store"
+ },
+ {
+ "name": "proxy",
+ "type": "Roo.data.DataProxy",
+ "desc": "The Proxy object which provides access to a data object.",
+ "memberOf": "Roo.data.Store"
+ },
+ {
+ "name": "data",
+ "type": "Array",
+ "desc": "Inline data to be loaded when the store is initialized.",
+ "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 <em>id</em> property.",
+ "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"
+ },
+ {
+ "name": "sortInfo",
+ "type": "Object",
+ "desc": "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
+ "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"
+ },
+ {
+ "name": "remoteSort",
+ "type": "boolean",
+ "desc": "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
+ "memberOf": "Roo.data.Store"
+ },
+ {
+ "name": "pruneModifiedRecords",
+ "type": "boolean",
+ "desc": "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
+ "memberOf": "Roo.data.Store"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "add",
+ "sig": "function (_self, records, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when Records have been added to the Store"
+ },
+ {
+ "name": "beforeload",
+ "sig": "function (_self, options)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "clear",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the data cache has been cleared."
+ },
+ {
+ "name": "datachanged",
+ "sig": "function (_self)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "load",
+ "sig": "function (_self, records, options)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after a new set of Records has been loaded."
+ },
+ {
+ "name": "loadexception",
+ "sig": "function (, return, load, jsonData)\n{\n\n}",
+ "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"
+ },
+ {
+ "name": "metachange",
+ "sig": "function (_self, meta)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders."
+ },
+ {
+ "name": "remove",
+ "sig": "function (_self, record, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a Record has been removed from the Store"
+ },
+ {
+ "name": "update",
+ "sig": "function (_self, record, operation)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a Record has been updated"
+ }
+ ]
+ },
+ "Roo.data.MemoryProxy": {
+ "props": [],
+ "events": []
+ },
+ "Roo.data.Node": {
+ "props": [
+ {
+ "name": "leaf",
+ "type": "Boolean",
+ "desc": "true if this node is a leaf and does not have children",
+ "memberOf": ""
+ },
+ {
+ "name": "id",
+ "type": "String",
+ "desc": "The id for this node. If one is not specified, one is generated.",
+ "memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "append",
+ "sig": "function (tree, _self, node, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a new child node is appended"
+ },
+ {
+ "name": "beforeappend",
+ "sig": "function (tree, _self, node)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a new child is appended, return false to cancel the append."
+ },
+ {
+ "name": "beforeinsert",
+ "sig": "function (tree, _self, node, refNode)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a new child is inserted, return false to cancel the insert."
+ },
+ {
+ "name": "beforemove",
+ "sig": "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before this node is moved to a new location in the tree. Return false to cancel the move."
+ },
+ {
+ "name": "beforeremove",
+ "sig": "function (tree, _self, node)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a child is removed, return false to cancel the remove."
+ },
+ {
+ "name": "insert",
+ "sig": "function (tree, _self, node, refNode)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a new child node is inserted."
+ },
+ {
+ "name": "move",
+ "sig": "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this node is moved to a new location in the tree"
+ },
+ {
+ "name": "remove",
+ "sig": "function (tree, _self, node)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a child node is removed"
+ }
+ ]
+ },
+ "Roo.data.Record": {
+ "props": [],
+ "events": []
+ },
+ "Roo.data.ScriptTagProxy": {
+ "props": [
+ {
+ "name": "url",
+ "type": "String",
+ "desc": "The URL from which to request the data object.",
+ "memberOf": ""
+ },
+ {
+ "name": "timeout",
+ "type": "Number",
+ "desc": "(Optional) The number of milliseconds to wait for a response. Defaults to 30 seconds.",
+ "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\".<p>The server-side processing must read this parameter value, and generate\njavascript output which calls this named function passing the data object as its only parameter.",
+ "memberOf": ""
+ },
+ {
+ "name": "nocache",
+ "type": "Boolean",
+ "desc": "(Optional) Defaults to true. Disable cacheing by adding a unique parameter\nname to the request.",
+ "memberOf": ""
+ }
+ ],
+ "events": []
+ },
+ "Roo.data.SimpleStore": {
+ "props": [
+ {
+ "name": "id",
+ "type": "Number",
+ "desc": "The array index of the record id. Leave blank to auto generate ids.",
+ "memberOf": ""
+ },
+ {
+ "name": "fields",
+ "type": "Array",
+ "desc": "An array of field definition objects, or field name strings.",
+ "memberOf": ""
+ },
+ {
+ "name": "data",
+ "type": "Array",
+ "desc": "The multi-dimensional array of data",
+ "memberOf": ""
+ },
+ {
+ "name": "isLocal",
+ "type": "boolean",
+ "desc": "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
+ "memberOf": "Roo.data.Store"
+ },
+ {
+ "name": "proxy",
+ "type": "Roo.data.DataProxy",
+ "desc": "The Proxy object which provides access to a data object.",
+ "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 <em>id</em> property.",
+ "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"
+ },
+ {
+ "name": "sortInfo",
+ "type": "Object",
+ "desc": "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
+ "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"
+ },
+ {
+ "name": "remoteSort",
+ "type": "boolean",
+ "desc": "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
+ "memberOf": "Roo.data.Store"
+ },
+ {
+ "name": "pruneModifiedRecords",
+ "type": "boolean",
+ "desc": "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
+ "memberOf": "Roo.data.Store"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "add",
+ "sig": "function (_self, records, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when Records have been added to the Store"
+ },
+ {
+ "name": "beforeload",
+ "sig": "function (_self, options)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "clear",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the data cache has been cleared."
+ },
+ {
+ "name": "datachanged",
+ "sig": "function (_self)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "load",
+ "sig": "function (_self, records, options)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after a new set of Records has been loaded."
+ },
+ {
+ "name": "loadexception",
+ "sig": "function (, return, load, jsonData)\n{\n\n}",
+ "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"
+ },
+ {
+ "name": "metachange",
+ "sig": "function (_self, meta)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders."
+ },
+ {
+ "name": "remove",
+ "sig": "function (_self, record, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a Record has been removed from the Store"
+ },
+ {
+ "name": "update",
+ "sig": "function (_self, record, operation)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a Record has been updated"
+ }
+ ]
+ },
+ "Roo.data.SortTypes": {
+ "props": [],
+ "events": []
+ },
+ "Roo.data.Store": {
+ "props": [
+ {
+ "name": "isLocal",
+ "type": "boolean",
+ "desc": "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
+ "memberOf": ""
+ },
+ {
+ "name": "proxy",
+ "type": "Roo.data.DataProxy",
+ "desc": "The Proxy object which provides access to a data object.",
+ "memberOf": ""
+ },
+ {
+ "name": "data",
+ "type": "Array",
+ "desc": "Inline data to be loaded when the store is initialized.",
+ "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 <em>id</em> property.",
+ "memberOf": ""
+ },
+ {
+ "name": "baseParams",
+ "type": "Object",
+ "desc": "An object containing properties which are to be sent as parameters\non any HTTP request",
+ "memberOf": ""
+ },
+ {
+ "name": "sortInfo",
+ "type": "Object",
+ "desc": "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
+ "memberOf": ""
+ },
+ {
+ "name": "multiSort",
+ "type": "Boolean",
+ "desc": "enable multi column sorting (sort is based on the order of columns, remote only at present)",
+ "memberOf": ""
+ },
+ {
+ "name": "remoteSort",
+ "type": "boolean",
+ "desc": "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
+ "memberOf": ""
+ },
+ {
+ "name": "pruneModifiedRecords",
+ "type": "boolean",
+ "desc": "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
+ "memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "add",
+ "sig": "function (_self, records, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when Records have been added to the Store"
+ },
+ {
+ "name": "beforeload",
+ "sig": "function (_self, options)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "clear",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the data cache has been cleared."
+ },
+ {
+ "name": "datachanged",
+ "sig": "function (_self)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "load",
+ "sig": "function (_self, records, options)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after a new set of Records has been loaded."
+ },
+ {
+ "name": "loadexception",
+ "sig": "function (, return, load, jsonData)\n{\n\n}",
+ "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"
+ },
+ {
+ "name": "metachange",
+ "sig": "function (_self, meta)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders."
+ },
+ {
+ "name": "remove",
+ "sig": "function (_self, record, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a Record has been removed from the Store"
+ },
+ {
+ "name": "update",
+ "sig": "function (_self, record, operation)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a Record has been updated"
+ }
+ ]
+ },
+ "Roo.data.Tree": {
+ "props": [
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "append",
+ "sig": "function (tree, parent, node, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a new child node is appended to a node in this tree."
+ },
+ {
+ "name": "beforeappend",
+ "sig": "function (tree, parent, node)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a new child is appended to a node in this tree, return false to cancel the append."
+ },
+ {
+ "name": "beforeinsert",
+ "sig": "function (tree, parent, node, refNode)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a new child is inserted in a node in this tree, return false to cancel the insert."
+ },
+ {
+ "name": "beforemove",
+ "sig": "function (tree, node, oldParent, newParent, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a node is moved to a new location in the tree. Return false to cancel the move."
+ },
+ {
+ "name": "beforeremove",
+ "sig": "function (tree, parent, node)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a child is removed from a node in this tree, return false to cancel the remove."
+ },
+ {
+ "name": "insert",
+ "sig": "function (tree, parent, node, refNode)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a new child node is inserted in a node in this tree."
+ },
+ {
+ "name": "move",
+ "sig": "function (tree, node, oldParent, newParent, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a node is moved to a new location in the tree"
+ },
+ {
+ "name": "remove",
+ "sig": "function (tree, parent, node)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a child node is removed from a node in this tree."
+ }
+ ]
+ },
+ "Roo.data.XmlReader": {
+ "props": [
+ {
+ "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": ""
+ },
+ {
+ "name": "record",
+ "type": "String",
+ "desc": "The DomQuery path to the repeated element which contains record information.",
+ "memberOf": ""
+ },
+ {
+ "name": "success",
+ "type": "String",
+ "desc": "The DomQuery path to the success attribute used by forms.",
+ "memberOf": ""
+ },
+ {
+ "name": "id",
+ "type": "String",
+ "desc": "The DomQuery path relative from the record element to the element that contains\na record identifier value.",
+ "memberOf": ""
+ }
+ ],
+ "events": []
+ },
+ "Roo.dd": {
+ "props": [],
+ "events": []
+ },
+ "Roo.dd.DD": {
+ "props": [
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": []
+ },
+ "Roo.dd.DDProxy": {
+ "props": [
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": []
+ },
+ "Roo.dd.DDTarget": {
+ "props": [
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": []
+ },
+ "Roo.dd.DragDrop": {
+ "props": [
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": []
+ },
+ "Roo.dd.DragDropMgr": {
+ "props": [],
+ "events": []
+ },
+ "Roo.dd.DragSource": {
+ "props": [
+ {
+ "name": "dropAllowed",
+ "type": "String",
+ "desc": "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
+ "memberOf": ""
+ },
+ {
+ "name": "dropNotAllowed",
+ "type": "String",
+ "desc": "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
+ "memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": []
+ },
+ "Roo.dd.DragZone": {
+ "props": [
+ {
+ "name": "containerScroll",
+ "type": "Boolean",
+ "desc": "True to register this container with the Scrollmanager\nfor auto scrolling during drag operations.",
+ "memberOf": ""
+ },
+ {
+ "name": "hlColor",
+ "type": "String",
+ "desc": "The color to use when visually highlighting the drag source in the afterRepair\nmethod after a failed drop (defaults to \"c3daf9\" - light blue)",
+ "memberOf": ""
+ },
+ {
+ "name": "dropAllowed",
+ "type": "String",
+ "desc": "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
+ "memberOf": "Roo.dd.DragSource"
+ },
+ {
+ "name": "dropNotAllowed",
+ "type": "String",
+ "desc": "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
+ "memberOf": "Roo.dd.DragSource"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": []
+ },
+ "Roo.dd.DropTarget": {
+ "props": [
+ {
+ "name": "overClass",
+ "type": "String",
+ "desc": "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").",
+ "memberOf": ""
+ },
+ {
+ "name": "ddGroup",
+ "type": "String",
+ "desc": "The drag drop group to handle drop events for",
+ "memberOf": ""
+ },
+ {
+ "name": "dropAllowed",
+ "type": "String",
+ "desc": "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
+ "memberOf": ""
+ },
+ {
+ "name": "dropNotAllowed",
+ "type": "String",
+ "desc": "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
+ "memberOf": ""
+ },
+ {
+ "name": "success",
+ "type": "boolean",
+ "desc": "set this after drop listener..",
+ "memberOf": ""
+ },
+ {
+ "name": "valid",
+ "type": "boolean|String",
+ "desc": "true/false or string (ok-add/ok-sub/ok/nodrop)\nif the drop point is valid for over/enter..",
+ "memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "drop",
+ "sig": "function (source, e, data)\n{\n\n}",
+ "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"
+ },
+ {
+ "name": "enter",
+ "sig": "function (source, e, data)\n{\n\n}",
+ "type": "function",
+ "desc": "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.overClass and this.dropAllowed"
+ },
+ {
+ "name": "out",
+ "sig": "function (source, e, data)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "over",
+ "sig": "function (source, e, data)\n{\n\n}",
+ "type": "function",
+ "desc": "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.dropAllowed"
+ }
+ ]
+ },
+ "Roo.dd.DropZone": {
+ "props": [
+ {
+ "name": "overClass",
+ "type": "String",
+ "desc": "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").",
+ "memberOf": "Roo.dd.DropTarget"
+ },
+ {
+ "name": "ddGroup",
+ "type": "String",
+ "desc": "The drag drop group to handle drop events for",
+ "memberOf": "Roo.dd.DropTarget"
+ },
+ {
+ "name": "dropAllowed",
+ "type": "String",
+ "desc": "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
+ "memberOf": "Roo.dd.DropTarget"
+ },
+ {
+ "name": "dropNotAllowed",
+ "type": "String",
+ "desc": "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
+ "memberOf": "Roo.dd.DropTarget"
+ },
+ {
+ "name": "success",
+ "type": "boolean",
+ "desc": "set this after drop listener..",
+ "memberOf": "Roo.dd.DropTarget"
+ },
+ {
+ "name": "valid",
+ "type": "boolean|String",
+ "desc": "true/false or string (ok-add/ok-sub/ok/nodrop)\nif the drop point is valid for over/enter..",
+ "memberOf": "Roo.dd.DropTarget"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "drop",
+ "sig": "function (source, e, data)\n{\n\n}",
+ "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"
+ },
+ {
+ "name": "enter",
+ "sig": "function (source, e, data)\n{\n\n}",
+ "type": "function",
+ "desc": "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.overClass and this.dropAllowed"
+ },
+ {
+ "name": "out",
+ "sig": "function (source, e, data)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "over",
+ "sig": "function (source, e, data)\n{\n\n}",
+ "type": "function",
+ "desc": "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.dropAllowed"
+ }
+ ]
+ },
+ "Roo.dd.Registry": {
+ "props": [],
+ "events": []
+ },
+ "Roo.dd.ScrollManager": {
+ "props": [],
+ "events": []
+ },
+ "Roo.dd.StatusProxy": {
+ "props": [
+ {
+ "name": "dropAllowed",
+ "type": "String",
+ "desc": "The CSS class to apply to the status element when drop is allowed (defaults to \"x-dd-drop-ok\").",
+ "memberOf": ""
+ },
+ {
+ "name": "dropNotAllowed",
+ "type": "String",
+ "desc": "The CSS class to apply to the status element when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
+ "memberOf": ""
+ }
+ ],
+ "events": []
+ },
+ "Roo.form": {
+ "props": [],
+ "events": []
+ },
+ "Roo.form.Action": {
+ "props": [],
+ "events": []
+ },
+ "Roo.form.BasicForm": {
+ "props": [
+ {
+ "name": "method",
+ "type": "String",
+ "desc": "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.",
+ "memberOf": ""
+ },
+ {
+ "name": "reader",
+ "type": "DataReader",
+ "desc": "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.",
+ "memberOf": ""
+ },
+ {
+ "name": "errorReader",
+ "type": "DataReader",
+ "desc": "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on \"submit\" actions.\nThis is completely optional as there is built-in support for processing JSON.",
+ "memberOf": ""
+ },
+ {
+ "name": "url",
+ "type": "String",
+ "desc": "The URL to use for form actions if one isn't supplied in the action options.",
+ "memberOf": ""
+ },
+ {
+ "name": "fileUpload",
+ "type": "Boolean",
+ "desc": "Set to true if this form is a file upload.",
+ "memberOf": ""
+ },
+ {
+ "name": "baseParams",
+ "type": "Object",
+ "desc": "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
+ "memberOf": ""
+ },
+ {
+ "name": "timeout",
+ "type": "Number",
+ "desc": "Timeout for form actions in seconds (default is 30 seconds).",
+ "memberOf": ""
+ },
+ {
+ "name": "trackResetOnLoad",
+ "type": "Boolean",
+ "desc": "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.",
+ "memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "actioncomplete",
+ "sig": "function (_self, action)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when an action is completed."
+ },
+ {
+ "name": "actionfailed",
+ "sig": "function (_self, action)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when an action fails."
+ },
+ {
+ "name": "beforeaction",
+ "sig": "function (_self, action)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before any action is performed. Return false to cancel the action."
+ }
+ ]
+ },
+ "Roo.form.Checkbox": {
+ "props": [
+ {
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the checkbox receives focus (defaults to undefined)",
+ "memberOf": ""
+ },
+ {
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "memberOf": ""
+ },
+ {
+ "name": "checked",
+ "type": "Boolean",
+ "desc": "True if the the checkbox should render already checked (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "autoCreate",
+ "type": "String/Object",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
+ "memberOf": ""
+ },
+ {
+ "name": "boxLabel",
+ "type": "String",
+ "desc": "The text that appears beside the checkbox",
+ "memberOf": ""
+ },
+ {
+ "name": "inputValue",
+ "type": "String",
+ "desc": "The value that should go into the generated input element's value attribute",
+ "memberOf": ""
+ },
+ {
+ "name": "valueOff",
+ "type": "String",
+ "desc": "The value that should go into the generated input element's value when unchecked.",
+ "memberOf": ""
+ },
+ {
+ "name": "fieldLabel",
+ "type": "String",
+ "desc": "Label to use when rendering a form.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "qtip",
+ "type": "String",
+ "desc": "Mouse over tip",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "desc": "The field's HTML name attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationEvent",
+ "type": "String/Boolean",
+ "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validateOnBlur",
+ "type": "Boolean",
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgTarget",
+ "type": "String",
+ "desc": "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\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</pre>",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgFx",
+ "type": "String",
+ "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "True to disable the field (defaults to false).",
+ "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"
+ },
+ {
+ "name": "tabIndex",
+ "type": "Number",
+ "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "value",
+ "type": "Mixed",
+ "desc": "A value to initialize this field with.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "A CSS class to apply to the field's underlying element.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "width",
+ "type": "Number",
+ "desc": "width (optional) size of component",
+ "memberOf": "Roo.BoxComponent"
+ },
+ {
+ "name": "height",
+ "type": "Number",
+ "desc": "height (optional) size of component",
+ "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"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "blur",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field loses input focus."
+ },
+ {
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires just before the field blurs if the field value has changed."
+ },
+ {
+ "name": "check",
+ "sig": "function (_self, checked)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the checkbox is checked or unchecked."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field receives input focus."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been marked as invalid."
+ },
+ {
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the key up"
+ },
+ {
+ "name": "move",
+ "sig": "function (_self, x, y)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is moved."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "resize",
+ "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is resized."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ },
+ {
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
+ }
+ ]
+ },
+ "Roo.form.Column": {
+ "props": [
+ {
+ "name": "width",
+ "type": "Number/String",
+ "desc": "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
+ "memberOf": ""
+ },
+ {
+ "name": "autoCreate",
+ "type": "String/Object",
+ "desc": "A DomHelper element spec used to autocreate the column (defaults to {tag: 'div', cls: 'x-form-ct x-form-column'})",
+ "memberOf": ""
+ },
+ {
+ "name": "style",
+ "type": "String/Object/Function",
+ "desc": "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
+ "memberOf": "Roo.form.Layout"
+ },
+ {
+ "name": "labelAlign",
+ "type": "String",
+ "desc": "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
+ "memberOf": "Roo.form.Layout"
+ },
+ {
+ "name": "labelWidth",
+ "type": "Number",
+ "desc": "Fixed width in pixels of all field labels (defaults to undefined)",
+ "memberOf": "Roo.form.Layout"
+ },
+ {
+ "name": "clear",
+ "type": "Boolean",
+ "desc": "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
+ "memberOf": "Roo.form.Layout"
+ },
+ {
+ "name": "labelSeparator",
+ "type": "String",
+ "desc": "The separator to use after field labels (defaults to ':')",
+ "memberOf": "Roo.form.Layout"
+ },
+ {
+ "name": "hideLabels",
+ "type": "Boolean",
+ "desc": "True to suppress the display of field labels in this layout (defaults to false)",
+ "memberOf": "Roo.form.Layout"
+ },
+ {
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ }
+ ]
+ },
+ "Roo.form.ComboBox": {
+ "props": [
+ {
+ "name": "transform",
+ "type": "String/HTMLElement/Element",
+ "desc": "The id, DOM node or element of an existing select to convert to a ComboBox",
+ "memberOf": ""
+ },
+ {
+ "name": "lazyRender",
+ "type": "Boolean",
+ "desc": "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "autoCreate",
+ "type": "Boolean/Object",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
+ "memberOf": ""
+ },
+ {
+ "name": "store",
+ "type": "Roo.data.Store",
+ "desc": "The data store to which this combo is bound (defaults to undefined)",
+ "memberOf": ""
+ },
+ {
+ "name": "title",
+ "type": "String",
+ "desc": "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
+ "memberOf": ""
+ },
+ {
+ "name": "grow",
+ "type": "Boolean",
+ "desc": "",
+ "memberOf": ""
+ },
+ {
+ "name": "growMin",
+ "type": "Number",
+ "desc": "",
+ "memberOf": ""
+ },
+ {
+ "name": "growMax",
+ "type": "Number",
+ "desc": "",
+ "memberOf": ""
+ },
+ {
+ "name": "tpl",
+ "type": "String/Roo.Template",
+ "desc": "The template to use to render the output",
+ "memberOf": ""
+ },
+ {
+ "name": "listWidth",
+ "type": "Number",
+ "desc": "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
+ "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": ""
+ },
+ {
+ "name": "valueField",
+ "type": "String",
+ "desc": "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
+ "memberOf": ""
+ },
+ {
+ "name": "hiddenName",
+ "type": "String",
+ "desc": "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
+ "memberOf": ""
+ },
+ {
+ "name": "listClass",
+ "type": "String",
+ "desc": "CSS class to apply to the dropdown list element (defaults to '')",
+ "memberOf": ""
+ },
+ {
+ "name": "selectedClass",
+ "type": "String",
+ "desc": "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
+ "memberOf": ""
+ },
+ {
+ "name": "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 <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
+ "memberOf": ""
+ },
+ {
+ "name": "shadow",
+ "type": "Boolean/String",
+ "desc": "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
+ "memberOf": ""
+ },
+ {
+ "name": "listAlign",
+ "type": "String",
+ "desc": "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
+ "memberOf": ""
+ },
+ {
+ "name": "maxHeight",
+ "type": "Number",
+ "desc": "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
+ "memberOf": ""
+ },
+ {
+ "name": "triggerAction",
+ "type": "String",
+ "desc": "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
+ "memberOf": ""
+ },
+ {
+ "name": "minChars",
+ "type": "Number",
+ "desc": "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
+ "memberOf": ""
+ },
+ {
+ "name": "typeAhead",
+ "type": "Boolean",
+ "desc": "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "queryDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
+ "memberOf": ""
+ },
+ {
+ "name": "pageSize",
+ "type": "Number",
+ "desc": "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
+ "memberOf": ""
+ },
+ {
+ "name": "selectOnFocus",
+ "type": "Boolean",
+ "desc": "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "queryParam",
+ "type": "String",
+ "desc": "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "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": ""
+ },
+ {
+ "name": "resizable",
+ "type": "Boolean",
+ "desc": "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "handleHeight",
+ "type": "Number",
+ "desc": "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
+ "memberOf": ""
+ },
+ {
+ "name": "editable",
+ "type": "Boolean",
+ "desc": "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
+ "memberOf": ""
+ },
+ {
+ "name": "allQuery",
+ "type": "String",
+ "desc": "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
+ "memberOf": ""
+ },
+ {
+ "name": "mode",
+ "type": "String",
+ "desc": "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
+ "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": ""
+ },
+ {
+ "name": "forceSelection",
+ "type": "Boolean",
+ "desc": "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "typeAheadDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
+ "memberOf": ""
+ },
+ {
+ "name": "valueNotFoundText",
+ "type": "String",
+ "desc": "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
+ "memberOf": ""
+ },
+ {
+ "name": "blockFocus",
+ "type": "Boolean",
+ "desc": "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "memberOf": ""
+ },
+ {
+ "name": "disableClear",
+ "type": "Boolean",
+ "desc": "Disable showing of clear button.",
+ "memberOf": ""
+ },
+ {
+ "name": "alwaysQuery",
+ "type": "Boolean",
+ "desc": "Disable caching of results, and always send query",
+ "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"
+ },
+ {
+ "name": "vtype",
+ "type": "String",
+ "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "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"
+ },
+ {
+ "name": "disableKeyFilter",
+ "type": "Boolean",
+ "desc": "True to disable input keystroke filtering (defaults to false)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "allowBlank",
+ "type": "Boolean",
+ "desc": "False to validate that the value length > 0 (defaults to true)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "minLength",
+ "type": "Number",
+ "desc": "Minimum input field length required (defaults to 0)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maxLength",
+ "type": "Number",
+ "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "minLengthText",
+ "type": "String",
+ "desc": "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maxLengthText",
+ "type": "String",
+ "desc": "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "blankText",
+ "type": "String",
+ "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "validator",
+ "type": "Function",
+ "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "regex",
+ "type": "RegExp",
+ "desc": "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "regexText",
+ "type": "String",
+ "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "emptyText",
+ "type": "String",
+ "desc": "The default text to display in an empty field (defaults to null).",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "emptyClass",
+ "type": "String",
+ "desc": "The CSS class to apply to an empty field to style the {@link #emptyText} (defaults to\n'x-form-empty-field'). This class is automatically added and removed as needed depending on the current field value.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "fieldLabel",
+ "type": "String",
+ "desc": "Label to use when rendering a form.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "qtip",
+ "type": "String",
+ "desc": "Mouse over tip",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "desc": "The field's HTML name attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationEvent",
+ "type": "String/Boolean",
+ "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validateOnBlur",
+ "type": "Boolean",
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the field (defaults to \"x-form-field\")",
+ "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<pre>\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</pre>",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgFx",
+ "type": "String",
+ "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "True to disable the field (defaults to false).",
+ "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"
+ },
+ {
+ "name": "tabIndex",
+ "type": "Number",
+ "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "value",
+ "type": "Mixed",
+ "desc": "A value to initialize this field with.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "A CSS class to apply to the field's underlying element.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "width",
+ "type": "Number",
+ "desc": "width (optional) size of component",
+ "memberOf": "Roo.BoxComponent"
+ },
+ {
+ "name": "height",
+ "type": "Number",
+ "desc": "height (optional) size of component",
+ "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"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "add",
+ "sig": "function (combo)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the 'add' icon is pressed (add a listener to enable add button)"
+ },
+ {
+ "name": "autosize",
+ "sig": "function (_self, width)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforequery",
+ "sig": "function (combo, query, forceAll, cancel, e)\n{\n\n}",
+ "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:"
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeselect",
+ "sig": "function (combo, record, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a list item is selected. Return false to cancel the selection."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "blur",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field loses input focus."
+ },
+ {
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires just before the field blurs if the field value has changed."
+ },
+ {
+ "name": "collapse",
+ "sig": "function (combo)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the dropdown list is collapsed"
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "edit",
+ "sig": "function (combo, record)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the 'edit' icon is pressed (add a listener to enable add button)"
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "expand",
+ "sig": "function (combo)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the dropdown list is expanded"
+ },
+ {
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field receives input focus."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been marked as invalid."
+ },
+ {
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the key up"
+ },
+ {
+ "name": "move",
+ "sig": "function (_self, x, y)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is moved."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "resize",
+ "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is resized."
+ },
+ {
+ "name": "select",
+ "sig": "function (combo, record, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a list item is selected"
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ },
+ {
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
+ }
+ ]
+ },
+ "Roo.form.ComboCheck": {
+ "props": [
+ {
+ "name": "transform",
+ "type": "String/HTMLElement/Element",
+ "desc": "The id, DOM node or element of an existing select to convert to a ComboBox",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "lazyRender",
+ "type": "Boolean",
+ "desc": "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "autoCreate",
+ "type": "Boolean/Object",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "store",
+ "type": "Roo.data.Store",
+ "desc": "The data store to which this combo is bound (defaults to undefined)",
+ "memberOf": "Roo.form.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.form.ComboBox"
+ },
+ {
+ "name": "grow",
+ "type": "Boolean",
+ "desc": "",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "growMin",
+ "type": "Number",
+ "desc": "",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "growMax",
+ "type": "Number",
+ "desc": "",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "tpl",
+ "type": "String/Roo.Template",
+ "desc": "The template to use to render the output",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "listWidth",
+ "type": "Number",
+ "desc": "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "displayField",
+ "type": "String",
+ "desc": "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "valueField",
+ "type": "String",
+ "desc": "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "hiddenName",
+ "type": "String",
+ "desc": "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "listClass",
+ "type": "String",
+ "desc": "CSS class to apply to the dropdown list element (defaults to '')",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "selectedClass",
+ "type": "String",
+ "desc": "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "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 <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "shadow",
+ "type": "Boolean/String",
+ "desc": "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "listAlign",
+ "type": "String",
+ "desc": "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "maxHeight",
+ "type": "Number",
+ "desc": "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "triggerAction",
+ "type": "String",
+ "desc": "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "minChars",
+ "type": "Number",
+ "desc": "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "typeAhead",
+ "type": "Boolean",
+ "desc": "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "queryDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "pageSize",
+ "type": "Number",
+ "desc": "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "selectOnFocus",
+ "type": "Boolean",
+ "desc": "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "queryParam",
+ "type": "String",
+ "desc": "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "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"
+ },
+ {
+ "name": "resizable",
+ "type": "Boolean",
+ "desc": "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "handleHeight",
+ "type": "Number",
+ "desc": "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "editable",
+ "type": "Boolean",
+ "desc": "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "allQuery",
+ "type": "String",
+ "desc": "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "mode",
+ "type": "String",
+ "desc": "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "minListWidth",
+ "type": "Number",
+ "desc": "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "forceSelection",
+ "type": "Boolean",
+ "desc": "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "typeAheadDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "valueNotFoundText",
+ "type": "String",
+ "desc": "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "blockFocus",
+ "type": "Boolean",
+ "desc": "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "disableClear",
+ "type": "Boolean",
+ "desc": "Disable showing of clear button.",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "alwaysQuery",
+ "type": "Boolean",
+ "desc": "Disable caching of results, and always send query",
+ "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"
+ },
+ {
+ "name": "vtype",
+ "type": "String",
+ "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "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"
+ },
+ {
+ "name": "disableKeyFilter",
+ "type": "Boolean",
+ "desc": "True to disable input keystroke filtering (defaults to false)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "allowBlank",
+ "type": "Boolean",
+ "desc": "False to validate that the value length > 0 (defaults to true)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "minLength",
+ "type": "Number",
+ "desc": "Minimum input field length required (defaults to 0)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maxLength",
+ "type": "Number",
+ "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "minLengthText",
+ "type": "String",
+ "desc": "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maxLengthText",
+ "type": "String",
+ "desc": "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "blankText",
+ "type": "String",
+ "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "validator",
+ "type": "Function",
+ "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "regex",
+ "type": "RegExp",
+ "desc": "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "regexText",
+ "type": "String",
+ "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "emptyText",
+ "type": "String",
+ "desc": "The default text to display in an empty field (defaults to null).",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "emptyClass",
+ "type": "String",
+ "desc": "The CSS class to apply to an empty field to style the {@link #emptyText} (defaults to\n'x-form-empty-field'). This class is automatically added and removed as needed depending on the current field value.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "fieldLabel",
+ "type": "String",
+ "desc": "Label to use when rendering a form.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "qtip",
+ "type": "String",
+ "desc": "Mouse over tip",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "desc": "The field's HTML name attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationEvent",
+ "type": "String/Boolean",
+ "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validateOnBlur",
+ "type": "Boolean",
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the field (defaults to \"x-form-field\")",
+ "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<pre>\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</pre>",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgFx",
+ "type": "String",
+ "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "True to disable the field (defaults to false).",
+ "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"
+ },
+ {
+ "name": "tabIndex",
+ "type": "Number",
+ "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "value",
+ "type": "Mixed",
+ "desc": "A value to initialize this field with.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "A CSS class to apply to the field's underlying element.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "width",
+ "type": "Number",
+ "desc": "width (optional) size of component",
+ "memberOf": "Roo.BoxComponent"
+ },
+ {
+ "name": "height",
+ "type": "Number",
+ "desc": "height (optional) size of component",
+ "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"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "add",
+ "sig": "function (combo)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the 'add' icon is pressed (add a listener to enable add button)"
+ },
+ {
+ "name": "autosize",
+ "sig": "function (_self, width)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforequery",
+ "sig": "function (combo, query, forceAll, cancel, e)\n{\n\n}",
+ "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:"
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeselect",
+ "sig": "function (combo, record, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a list item is selected. Return false to cancel the selection."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "blur",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field loses input focus."
+ },
+ {
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires just before the field blurs if the field value has changed."
+ },
+ {
+ "name": "collapse",
+ "sig": "function (combo)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the dropdown list is collapsed"
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "edit",
+ "sig": "function (combo, record)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the 'edit' icon is pressed (add a listener to enable add button)"
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "expand",
+ "sig": "function (combo)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the dropdown list is expanded"
+ },
+ {
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field receives input focus."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been marked as invalid."
+ },
+ {
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the key up"
+ },
+ {
+ "name": "move",
+ "sig": "function (_self, x, y)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is moved."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "resize",
+ "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is resized."
+ },
+ {
+ "name": "select",
+ "sig": "function (combo, record, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a list item is selected"
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ },
+ {
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
+ }
+ ]
+ },
+ "Roo.form.DateField": {
+ "props": [
+ {
+ "name": "format",
+ "type": "String",
+ "desc": "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').",
+ "memberOf": ""
+ },
+ {
+ "name": "altFormats",
+ "type": "String",
+ "desc": "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').",
+ "memberOf": ""
+ },
+ {
+ "name": "disabledDays",
+ "type": "Array",
+ "desc": "An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).",
+ "memberOf": ""
+ },
+ {
+ "name": "disabledDaysText",
+ "type": "String",
+ "desc": "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')",
+ "memberOf": ""
+ },
+ {
+ "name": "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<ul>\n<li>[\"03/08/2003\", \"09/16/2003\"] would disable those exact dates</li>\n<li>[\"03/08\", \"09/16\"] would disable those days for every year</li>\n<li>[\"^03/08\"] would only match the beginning (useful if you are using short years)</li>\n<li>[\"03/../2006\"] would disable every day in March 2006</li>\n<li>[\"^03\"] would disable every day in every March</li>\n</ul>\nIn order to support regular expressions, if you are using a date format that has \".\" in it, you will have to\nescape the dot when restricting dates. For example: [\"03\\\\.08\\\\.03\"].",
+ "memberOf": ""
+ },
+ {
+ "name": "disabledDatesText",
+ "type": "String",
+ "desc": "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')",
+ "memberOf": ""
+ },
+ {
+ "name": "minValue",
+ "type": "Date/String",
+ "desc": "The minimum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
+ "memberOf": ""
+ },
+ {
+ "name": "maxValue",
+ "type": "Date/String",
+ "desc": "The maximum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
+ "memberOf": ""
+ },
+ {
+ "name": "minText",
+ "type": "String",
+ "desc": "The error text to display when the date in the cell is before minValue (defaults to\n'The date in this field must be after {minValue}').",
+ "memberOf": ""
+ },
+ {
+ "name": "maxText",
+ "type": "String",
+ "desc": "The error text to display when the date in the cell is after maxValue (defaults to\n'The date in this field must be before {maxValue}').",
+ "memberOf": ""
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to display when the date in the field is invalid (defaults to\n'{value} is not a valid date - it must be in the format {format}').",
+ "memberOf": ""
+ },
+ {
+ "name": "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 <b>appended</b> if specified (defaults to 'x-form-date-trigger'\nwhich displays a calendar icon).",
+ "memberOf": ""
+ },
+ {
+ "name": "useIso",
+ "type": "bool",
+ "desc": "if enabled, then the date field will use a hidden field to store the \nreal value as iso formated date. default (false)",
+ "memberOf": ""
+ },
+ {
+ "name": "autoCreate",
+ "type": "String/Object",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"10\", autocomplete: \"off\"})",
+ "memberOf": ""
+ },
+ {
+ "name": "hideTrigger",
+ "type": "Boolean",
+ "desc": "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf": "Roo.form.TriggerField"
+ },
+ {
+ "name": "vtype",
+ "type": "String",
+ "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "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"
+ },
+ {
+ "name": "disableKeyFilter",
+ "type": "Boolean",
+ "desc": "True to disable input keystroke filtering (defaults to false)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "allowBlank",
+ "type": "Boolean",
+ "desc": "False to validate that the value length > 0 (defaults to true)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "minLength",
+ "type": "Number",
+ "desc": "Minimum input field length required (defaults to 0)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maxLength",
+ "type": "Number",
+ "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "minLengthText",
+ "type": "String",
+ "desc": "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maxLengthText",
+ "type": "String",
+ "desc": "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "selectOnFocus",
+ "type": "Boolean",
+ "desc": "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "blankText",
+ "type": "String",
+ "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "validator",
+ "type": "Function",
+ "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "regex",
+ "type": "RegExp",
+ "desc": "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "regexText",
+ "type": "String",
+ "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "emptyText",
+ "type": "String",
+ "desc": "The default text to display in an empty field (defaults to null).",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "emptyClass",
+ "type": "String",
+ "desc": "The CSS class to apply to an empty field to style the {@link #emptyText} (defaults to\n'x-form-empty-field'). This class is automatically added and removed as needed depending on the current field value.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "fieldLabel",
+ "type": "String",
+ "desc": "Label to use when rendering a form.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "qtip",
+ "type": "String",
+ "desc": "Mouse over tip",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "desc": "The field's HTML name attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationEvent",
+ "type": "String/Boolean",
+ "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validateOnBlur",
+ "type": "Boolean",
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the field (defaults to \"x-form-field\")",
+ "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<pre>\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</pre>",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgFx",
+ "type": "String",
+ "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "True to disable the field (defaults to false).",
+ "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"
+ },
+ {
+ "name": "tabIndex",
+ "type": "Number",
+ "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "value",
+ "type": "Mixed",
+ "desc": "A value to initialize this field with.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "A CSS class to apply to the field's underlying element.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "width",
+ "type": "Number",
+ "desc": "width (optional) size of component",
+ "memberOf": "Roo.BoxComponent"
+ },
+ {
+ "name": "height",
+ "type": "Number",
+ "desc": "height (optional) size of component",
+ "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"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "autosize",
+ "sig": "function (_self, width)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "blur",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field loses input focus."
+ },
+ {
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires just before the field blurs if the field value has changed."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field receives input focus."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been marked as invalid."
+ },
+ {
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the key up"
+ },
+ {
+ "name": "move",
+ "sig": "function (_self, x, y)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is moved."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "resize",
+ "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is resized."
+ },
+ {
+ "name": "select",
+ "sig": "function (combo, date)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a date is selected"
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ },
+ {
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
+ }
+ ]
+ },
+ "Roo.form.DayPicker": {
+ "props": [
+ {
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the checkbox receives focus (defaults to undefined)",
+ "memberOf": ""
+ },
+ {
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "memberOf": ""
+ },
+ {
+ "name": "autoCreate",
+ "type": "String/Object",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
+ "memberOf": ""
+ },
+ {
+ "name": "fieldLabel",
+ "type": "String",
+ "desc": "Label to use when rendering a form.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "qtip",
+ "type": "String",
+ "desc": "Mouse over tip",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "desc": "The field's HTML name attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationEvent",
+ "type": "String/Boolean",
+ "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validateOnBlur",
+ "type": "Boolean",
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgTarget",
+ "type": "String",
+ "desc": "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\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</pre>",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgFx",
+ "type": "String",
+ "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "True to disable the field (defaults to false).",
+ "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"
+ },
+ {
+ "name": "tabIndex",
+ "type": "Number",
+ "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "value",
+ "type": "Mixed",
+ "desc": "A value to initialize this field with.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "A CSS class to apply to the field's underlying element.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "width",
+ "type": "Number",
+ "desc": "width (optional) size of component",
+ "memberOf": "Roo.BoxComponent"
+ },
+ {
+ "name": "height",
+ "type": "Number",
+ "desc": "height (optional) size of component",
+ "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"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "blur",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field loses input focus."
+ },
+ {
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires just before the field blurs if the field value has changed."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field receives input focus."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been marked as invalid."
+ },
+ {
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the key up"
+ },
+ {
+ "name": "move",
+ "sig": "function (_self, x, y)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is moved."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "resize",
+ "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is resized."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ },
+ {
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
+ }
+ ]
+ },
+ "Roo.form.DisplayField": {
+ "props": [
+ {
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the checkbox receives focus (defaults to undefined)",
+ "memberOf": ""
+ },
+ {
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "memberOf": ""
+ },
+ {
+ "name": "valueRenderer",
+ "type": "Function",
+ "desc": "The renderer for the field (so you can reformat output). should return raw HTML",
+ "memberOf": ""
+ },
+ {
+ "name": "autoCreate",
+ "type": "String/Object",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
+ "memberOf": ""
+ },
+ {
+ "name": "fieldLabel",
+ "type": "String",
+ "desc": "Label to use when rendering a form.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "qtip",
+ "type": "String",
+ "desc": "Mouse over tip",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "desc": "The field's HTML name attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationEvent",
+ "type": "String/Boolean",
+ "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validateOnBlur",
+ "type": "Boolean",
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgTarget",
+ "type": "String",
+ "desc": "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\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</pre>",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgFx",
+ "type": "String",
+ "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "True to disable the field (defaults to false).",
+ "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"
+ },
+ {
+ "name": "tabIndex",
+ "type": "Number",
+ "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "value",
+ "type": "Mixed",
+ "desc": "A value to initialize this field with.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "A CSS class to apply to the field's underlying element.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "width",
+ "type": "Number",
+ "desc": "width (optional) size of component",
+ "memberOf": "Roo.BoxComponent"
+ },
+ {
+ "name": "height",
+ "type": "Number",
+ "desc": "height (optional) size of component",
+ "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"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "blur",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field loses input focus."
+ },
+ {
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires just before the field blurs if the field value has changed."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field receives input focus."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been marked as invalid."
+ },
+ {
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the key up"
+ },
+ {
+ "name": "move",
+ "sig": "function (_self, x, y)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is moved."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "resize",
+ "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is resized."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ },
+ {
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
+ }
+ ]
+ },
+ "Roo.form.FCKeditor": {
+ "props": [
+ {
+ "name": "fck",
+ "type": "Object",
+ "desc": "options - see fck manual for details.",
+ "memberOf": ""
+ },
+ {
+ "name": "growMin",
+ "type": "Number",
+ "desc": "The minimum height to allow when grow = true (defaults to 60)",
+ "memberOf": "Roo.form.TextArea"
+ },
+ {
+ "name": "growMax",
+ "type": "Number",
+ "desc": "The maximum height to allow when grow = true (defaults to 1000)",
+ "memberOf": "Roo.form.TextArea"
+ },
+ {
+ "name": "preventScrollbars",
+ "type": "Boolean",
+ "desc": "True to prevent scrollbars from appearing regardless of how much text is\nin the field (equivalent to setting overflow: hidden, defaults to false)",
+ "memberOf": "Roo.form.TextArea"
+ },
+ {
+ "name": "autoCreate",
+ "type": "String/Object",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"textarea\", style: \"width:300px;height:60px;\", autocomplete: \"off\"})",
+ "memberOf": "Roo.form.TextArea"
+ },
+ {
+ "name": "grow",
+ "type": "Boolean",
+ "desc": "True if this field should automatically grow and shrink to its content",
+ "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"
+ },
+ {
+ "name": "maskRe",
+ "type": "String",
+ "desc": "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "disableKeyFilter",
+ "type": "Boolean",
+ "desc": "True to disable input keystroke filtering (defaults to false)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "allowBlank",
+ "type": "Boolean",
+ "desc": "False to validate that the value length > 0 (defaults to true)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "minLength",
+ "type": "Number",
+ "desc": "Minimum input field length required (defaults to 0)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maxLength",
+ "type": "Number",
+ "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "minLengthText",
+ "type": "String",
+ "desc": "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maxLengthText",
+ "type": "String",
+ "desc": "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "selectOnFocus",
+ "type": "Boolean",
+ "desc": "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "blankText",
+ "type": "String",
+ "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "validator",
+ "type": "Function",
+ "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "regex",
+ "type": "RegExp",
+ "desc": "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "regexText",
+ "type": "String",
+ "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "emptyText",
+ "type": "String",
+ "desc": "The default text to display in an empty field (defaults to null).",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "emptyClass",
+ "type": "String",
+ "desc": "The CSS class to apply to an empty field to style the {@link #emptyText} (defaults to\n'x-form-empty-field'). This class is automatically added and removed as needed depending on the current field value.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "fieldLabel",
+ "type": "String",
+ "desc": "Label to use when rendering a form.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "qtip",
+ "type": "String",
+ "desc": "Mouse over tip",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "desc": "The field's HTML name attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationEvent",
+ "type": "String/Boolean",
+ "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validateOnBlur",
+ "type": "Boolean",
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the field (defaults to \"x-form-field\")",
+ "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<pre>\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</pre>",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgFx",
+ "type": "String",
+ "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "True to disable the field (defaults to false).",
+ "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"
+ },
+ {
+ "name": "tabIndex",
+ "type": "Number",
+ "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "value",
+ "type": "Mixed",
+ "desc": "A value to initialize this field with.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "A CSS class to apply to the field's underlying element.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "width",
+ "type": "Number",
+ "desc": "width (optional) size of component",
+ "memberOf": "Roo.BoxComponent"
+ },
+ {
+ "name": "height",
+ "type": "Number",
+ "desc": "height (optional) size of component",
+ "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"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "autosize",
+ "sig": "function (_self, width)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "blur",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field loses input focus."
+ },
+ {
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires just before the field blurs if the field value has changed."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "editorinit",
+ "sig": "function (_self, the)\n{\n\n}",
+ "type": "function",
+ "desc": "Fired when the editor is initialized - you can add extra handlers here.."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field receives input focus."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been marked as invalid."
+ },
+ {
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the key up"
+ },
+ {
+ "name": "move",
+ "sig": "function (_self, x, y)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is moved."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "resize",
+ "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is resized."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ },
+ {
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
+ }
+ ]
+ },
+ "Roo.form.Field": {
+ "props": [
+ {
+ "name": "fieldLabel",
+ "type": "String",
+ "desc": "Label to use when rendering a form.",
+ "memberOf": ""
+ },
+ {
+ "name": "qtip",
+ "type": "String",
+ "desc": "Mouse over tip",
+ "memberOf": ""
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "desc": "The field's HTML name attribute.",
+ "memberOf": ""
+ },
+ {
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": ""
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf": ""
+ },
+ {
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf": ""
+ },
+ {
+ "name": "validationEvent",
+ "type": "String/Boolean",
+ "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf": ""
+ },
+ {
+ "name": "validateOnBlur",
+ "type": "Boolean",
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": ""
+ },
+ {
+ "name": "validationDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf": ""
+ },
+ {
+ "name": "autoCreate",
+ "type": "String/Object",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
+ "memberOf": ""
+ },
+ {
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf": ""
+ },
+ {
+ "name": "msgTarget",
+ "type": "String",
+ "desc": "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\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</pre>",
+ "memberOf": ""
+ },
+ {
+ "name": "msgFx",
+ "type": "String",
+ "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf": ""
+ },
+ {
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf": ""
+ },
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "True to disable the field (defaults to false).",
+ "memberOf": ""
+ },
+ {
+ "name": "inputType",
+ "type": "String",
+ "desc": "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf": ""
+ },
+ {
+ "name": "tabIndex",
+ "type": "Number",
+ "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf": ""
+ },
+ {
+ "name": "value",
+ "type": "Mixed",
+ "desc": "A value to initialize this field with.",
+ "memberOf": ""
+ },
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "A CSS class to apply to the field's underlying element.",
+ "memberOf": ""
+ },
+ {
+ "name": "width",
+ "type": "Number",
+ "desc": "width (optional) size of component",
+ "memberOf": "Roo.BoxComponent"
+ },
+ {
+ "name": "height",
+ "type": "Number",
+ "desc": "height (optional) size of component",
+ "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"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "blur",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field loses input focus."
+ },
+ {
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires just before the field blurs if the field value has changed."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field receives input focus."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been marked as invalid."
+ },
+ {
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the key up"
+ },
+ {
+ "name": "move",
+ "sig": "function (_self, x, y)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is moved."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "resize",
+ "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is resized."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ },
+ {
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
+ }
+ ]
+ },
+ "Roo.form.FieldSet": {
+ "props": [
+ {
+ "name": "legend",
+ "type": "String",
+ "desc": "The text to display as the legend for the FieldSet (defaults to '')",
+ "memberOf": ""
+ },
+ {
+ "name": "autoCreate",
+ "type": "String/Object",
+ "desc": "A DomHelper element spec used to autocreate the fieldset (defaults to {tag: 'fieldset', cn: {tag:'legend'}})",
+ "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"
+ },
+ {
+ "name": "labelAlign",
+ "type": "String",
+ "desc": "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
+ "memberOf": "Roo.form.Layout"
+ },
+ {
+ "name": "labelWidth",
+ "type": "Number",
+ "desc": "Fixed width in pixels of all field labels (defaults to undefined)",
+ "memberOf": "Roo.form.Layout"
+ },
+ {
+ "name": "clear",
+ "type": "Boolean",
+ "desc": "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
+ "memberOf": "Roo.form.Layout"
+ },
+ {
+ "name": "labelSeparator",
+ "type": "String",
+ "desc": "The separator to use after field labels (defaults to ':')",
+ "memberOf": "Roo.form.Layout"
+ },
+ {
+ "name": "hideLabels",
+ "type": "Boolean",
+ "desc": "True to suppress the display of field labels in this layout (defaults to false)",
+ "memberOf": "Roo.form.Layout"
+ },
+ {
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ }
+ ]
+ },
+ "Roo.form.Form": {
+ "props": [
+ {
+ "name": "labelWidth",
+ "type": "Number",
+ "desc": "The width of labels. This property cascades to child containers.",
+ "memberOf": ""
+ },
+ {
+ "name": "itemCls",
+ "type": "String",
+ "desc": "A css class to apply to the x-form-item of fields. This property cascades to child containers.",
+ "memberOf": ""
+ },
+ {
+ "name": "buttonAlign",
+ "type": "String",
+ "desc": "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"center\")",
+ "memberOf": ""
+ },
+ {
+ "name": "minButtonWidth",
+ "type": "Number",
+ "desc": "Minimum width of all buttons in pixels (defaults to 75)",
+ "memberOf": ""
+ },
+ {
+ "name": "labelAlign",
+ "type": "String",
+ "desc": "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\").\nThis property cascades to child containers if not set.",
+ "memberOf": ""
+ },
+ {
+ "name": "monitorValid",
+ "type": "Boolean",
+ "desc": "If true the form monitors its valid state <b>client-side</b> and\nfires a looping event with that state. This is required to bind buttons to the valid\nstate using the config value formBind:true on the button.",
+ "memberOf": ""
+ },
+ {
+ "name": "monitorPoll",
+ "type": "Number",
+ "desc": "The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)",
+ "memberOf": ""
+ },
+ {
+ "name": "progressUrl",
+ "type": "String",
+ "desc": "- Url to return progress data",
+ "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"
+ },
+ {
+ "name": "reader",
+ "type": "DataReader",
+ "desc": "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.",
+ "memberOf": "Roo.form.BasicForm"
+ },
+ {
+ "name": "errorReader",
+ "type": "DataReader",
+ "desc": "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on \"submit\" actions.\nThis is completely optional as there is built-in support for processing JSON.",
+ "memberOf": "Roo.form.BasicForm"
+ },
+ {
+ "name": "url",
+ "type": "String",
+ "desc": "The URL to use for form actions if one isn't supplied in the action options.",
+ "memberOf": "Roo.form.BasicForm"
+ },
+ {
+ "name": "fileUpload",
+ "type": "Boolean",
+ "desc": "Set to true if this form is a file upload.",
+ "memberOf": "Roo.form.BasicForm"
+ },
+ {
+ "name": "baseParams",
+ "type": "Object",
+ "desc": "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
+ "memberOf": "Roo.form.BasicForm"
+ },
+ {
+ "name": "timeout",
+ "type": "Number",
+ "desc": "Timeout for form actions in seconds (default is 30 seconds).",
+ "memberOf": "Roo.form.BasicForm"
+ },
+ {
+ "name": "trackResetOnLoad",
+ "type": "Boolean",
+ "desc": "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.",
+ "memberOf": "Roo.form.BasicForm"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "actioncomplete",
+ "sig": "function (_self, action)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when an action is completed."
+ },
+ {
+ "name": "actionfailed",
+ "sig": "function (_self, action)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when an action fails."
+ },
+ {
+ "name": "beforeaction",
+ "sig": "function (_self, action)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before any action is performed. Return false to cancel the action."
+ },
+ {
+ "name": "clientvalidation",
+ "sig": "function (_self, valid)\n{\n\n}",
+ "type": "function",
+ "desc": "If the monitorValid config option is true, this event fires repetitively to notify of valid state"
+ },
+ {
+ "name": "rendered",
+ "sig": "function (form)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the form is rendered"
+ }
+ ]
+ },
+ "Roo.form.GridField": {
+ "props": [
+ {
+ "name": "width",
+ "type": "Number",
+ "desc": "- used to restrict width of grid..",
+ "memberOf": ""
+ },
+ {
+ "name": "height",
+ "type": "Number",
+ "desc": "- used to restrict height of grid..",
+ "memberOf": ""
+ },
+ {
+ "name": "xgrid",
+ "type": "Object",
+ "desc": "(xtype'd description of grid) { xtype : 'Grid', dataSource: .... }\n\n}",
+ "memberOf": ""
+ },
+ {
+ "name": "autoCreate",
+ "type": "String/Object",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
+ "memberOf": ""
+ },
+ {
+ "name": "addTitle",
+ "type": "String",
+ "desc": "Text to include for adding a title.",
+ "memberOf": ""
+ },
+ {
+ "name": "fieldLabel",
+ "type": "String",
+ "desc": "Label to use when rendering a form.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "qtip",
+ "type": "String",
+ "desc": "Mouse over tip",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "desc": "The field's HTML name attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationEvent",
+ "type": "String/Boolean",
+ "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validateOnBlur",
+ "type": "Boolean",
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the field (defaults to \"x-form-field\")",
+ "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<pre>\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</pre>",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgFx",
+ "type": "String",
+ "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "True to disable the field (defaults to false).",
+ "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"
+ },
+ {
+ "name": "tabIndex",
+ "type": "Number",
+ "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "value",
+ "type": "Mixed",
+ "desc": "A value to initialize this field with.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "A CSS class to apply to the field's underlying element.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "blur",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field loses input focus."
+ },
+ {
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires just before the field blurs if the field value has changed."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field receives input focus."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been marked as invalid."
+ },
+ {
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the key up"
+ },
+ {
+ "name": "move",
+ "sig": "function (_self, x, y)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is moved."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "resize",
+ "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is resized."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ },
+ {
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
+ }
+ ]
+ },
+ "Roo.form.Hidden": {
+ "props": [
+ {
+ "name": "grow",
+ "type": "Boolean",
+ "desc": "True if this field should automatically grow and shrink to its content",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "growMin",
+ "type": "Number",
+ "desc": "The minimum width to allow when grow = true (defaults to 30)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "growMax",
+ "type": "Number",
+ "desc": "The maximum width to allow when grow = true (defaults to 800)",
+ "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"
+ },
+ {
+ "name": "maskRe",
+ "type": "String",
+ "desc": "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "disableKeyFilter",
+ "type": "Boolean",
+ "desc": "True to disable input keystroke filtering (defaults to false)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "allowBlank",
+ "type": "Boolean",
+ "desc": "False to validate that the value length > 0 (defaults to true)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "minLength",
+ "type": "Number",
+ "desc": "Minimum input field length required (defaults to 0)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maxLength",
+ "type": "Number",
+ "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "minLengthText",
+ "type": "String",
+ "desc": "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maxLengthText",
+ "type": "String",
+ "desc": "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "selectOnFocus",
+ "type": "Boolean",
+ "desc": "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "blankText",
+ "type": "String",
+ "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "validator",
+ "type": "Function",
+ "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "regex",
+ "type": "RegExp",
+ "desc": "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "regexText",
+ "type": "String",
+ "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "emptyText",
+ "type": "String",
+ "desc": "The default text to display in an empty field (defaults to null).",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "emptyClass",
+ "type": "String",
+ "desc": "The CSS class to apply to an empty field to style the {@link #emptyText} (defaults to\n'x-form-empty-field'). This class is automatically added and removed as needed depending on the current field value.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "fieldLabel",
+ "type": "String",
+ "desc": "Label to use when rendering a form.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "qtip",
+ "type": "String",
+ "desc": "Mouse over tip",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "desc": "The field's HTML name attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationEvent",
+ "type": "String/Boolean",
+ "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validateOnBlur",
+ "type": "Boolean",
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "autoCreate",
+ "type": "String/Object",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the field (defaults to \"x-form-field\")",
+ "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<pre>\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</pre>",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgFx",
+ "type": "String",
+ "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "True to disable the field (defaults to false).",
+ "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"
+ },
+ {
+ "name": "tabIndex",
+ "type": "Number",
+ "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "value",
+ "type": "Mixed",
+ "desc": "A value to initialize this field with.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "A CSS class to apply to the field's underlying element.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "width",
+ "type": "Number",
+ "desc": "width (optional) size of component",
+ "memberOf": "Roo.BoxComponent"
+ },
+ {
+ "name": "height",
+ "type": "Number",
+ "desc": "height (optional) size of component",
+ "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"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "autosize",
+ "sig": "function (_self, width)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "blur",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field loses input focus."
+ },
+ {
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires just before the field blurs if the field value has changed."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field receives input focus."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been marked as invalid."
+ },
+ {
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the key up"
+ },
+ {
+ "name": "move",
+ "sig": "function (_self, x, y)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is moved."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "resize",
+ "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is resized."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ },
+ {
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
+ }
+ ]
+ },
+ "Roo.form.HtmlEditor": {
+ "props": [
+ {
+ "name": "toolbars",
+ "type": "Array",
+ "desc": "Array of toolbars. - defaults to just the Standard one",
+ "memberOf": ""
+ },
+ {
+ "name": "createLinkText",
+ "type": "String",
+ "desc": "The default text for the create link prompt",
+ "memberOf": ""
+ },
+ {
+ "name": "defaultLinkValue",
+ "type": "String",
+ "desc": "The default value for the create link prompt (defaults to http:/ /)",
+ "memberOf": ""
+ },
+ {
+ "name": "resizable",
+ "type": "String",
+ "desc": "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.",
+ "memberOf": ""
+ },
+ {
+ "name": "height",
+ "type": "Number",
+ "desc": "(in pixels)",
+ "memberOf": ""
+ },
+ {
+ "name": "width",
+ "type": "Number",
+ "desc": "(in pixels)",
+ "memberOf": ""
+ },
+ {
+ "name": "stylesheets",
+ "type": "Array",
+ "desc": "url of stylesheets. set to [] to disable stylesheets.",
+ "memberOf": ""
+ }
+ ],
+ "events": [
+ {
+ "name": "activate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event."
+ },
+ {
+ "name": "beforepush",
+ "sig": "function (_self, html)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push."
+ },
+ {
+ "name": "beforesync",
+ "sig": "function (_self, html)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync."
+ },
+ {
+ "name": "editmodechange",
+ "sig": "function (_self, sourceEdit)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the editor switches edit modes"
+ },
+ {
+ "name": "editorevent",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks."
+ },
+ {
+ "name": "initialize",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the editor is fully initialized (including the iframe)"
+ },
+ {
+ "name": "push",
+ "sig": "function (_self, html)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the iframe editor is updated with content from the textarea."
+ },
+ {
+ "name": "sync",
+ "sig": "function (_self, html)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the textarea is updated with content from the editor iframe."
+ }
+ ]
+ },
+ "Roo.form.HtmlEditor.ToolbarContext": {
+ "props": [
+ {
+ "name": "disable",
+ "type": "Object",
+ "desc": "List of toolbar elements to disable",
+ "memberOf": ""
+ },
+ {
+ "name": "styles",
+ "type": "Object",
+ "desc": "List of styles \n eg. { '*' : [ 'headline' ] , 'TD' : [ 'underline', 'double-underline' ] } \n\nThese must be defined in the page, so they get rendered correctly..\n.headline { }\nTD.underline { }",
+ "memberOf": ""
+ }
+ ],
+ "events": []
+ },
+ "Roo.form.HtmlEditor.ToolbarStandard": {
+ "props": [
+ {
+ "name": "disable",
+ "type": "Object",
+ "desc": "List of elements to disable..",
+ "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": ""
+ },
+ {
+ "name": "fontFamilies",
+ "type": "Array",
+ "desc": "An array of available font families",
+ "memberOf": ""
+ },
+ {
+ "name": "defaultFont",
+ "type": "String",
+ "desc": "default font to use.",
+ "memberOf": ""
+ }
+ ],
+ "events": []
+ },
+ "Roo.form.Layout": {
+ "props": [
+ {
+ "name": "autoCreate",
+ "type": "String/Object",
+ "desc": "A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'})",
+ "memberOf": ""
+ },
+ {
+ "name": "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": ""
+ },
+ {
+ "name": "labelAlign",
+ "type": "String",
+ "desc": "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
+ "memberOf": ""
+ },
+ {
+ "name": "labelWidth",
+ "type": "Number",
+ "desc": "Fixed width in pixels of all field labels (defaults to undefined)",
+ "memberOf": ""
+ },
+ {
+ "name": "clear",
+ "type": "Boolean",
+ "desc": "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
+ "memberOf": ""
+ },
+ {
+ "name": "labelSeparator",
+ "type": "String",
+ "desc": "The separator to use after field labels (defaults to ':')",
+ "memberOf": ""
+ },
+ {
+ "name": "hideLabels",
+ "type": "Boolean",
+ "desc": "True to suppress the display of field labels in this layout (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ }
+ ]
+ },
+ "Roo.form.NumberField": {
+ "props": [
+ {
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the field (defaults to \"x-form-field x-form-num-field\")",
+ "memberOf": ""
+ },
+ {
+ "name": "allowDecimals",
+ "type": "Boolean",
+ "desc": "False to disallow decimal values (defaults to true)",
+ "memberOf": ""
+ },
+ {
+ "name": "decimalSeparator",
+ "type": "String",
+ "desc": "Character(s) to allow as the decimal separator (defaults to '.')",
+ "memberOf": ""
+ },
+ {
+ "name": "decimalPrecision",
+ "type": "Number",
+ "desc": "The maximum precision to display after the decimal separator (defaults to 2)",
+ "memberOf": ""
+ },
+ {
+ "name": "allowNegative",
+ "type": "Boolean",
+ "desc": "False to prevent entering a negative sign (defaults to true)",
+ "memberOf": ""
+ },
+ {
+ "name": "minValue",
+ "type": "Number",
+ "desc": "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
+ "memberOf": ""
+ },
+ {
+ "name": "maxValue",
+ "type": "Number",
+ "desc": "The maximum allowed value (defaults to Number.MAX_VALUE)",
+ "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": ""
+ },
+ {
+ "name": "maxText",
+ "type": "String",
+ "desc": "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")",
+ "memberOf": ""
+ },
+ {
+ "name": "nanText",
+ "type": "String",
+ "desc": "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")",
+ "memberOf": ""
+ },
+ {
+ "name": "grow",
+ "type": "Boolean",
+ "desc": "True if this field should automatically grow and shrink to its content",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "growMin",
+ "type": "Number",
+ "desc": "The minimum width to allow when grow = true (defaults to 30)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "growMax",
+ "type": "Number",
+ "desc": "The maximum width to allow when grow = true (defaults to 800)",
+ "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"
+ },
+ {
+ "name": "maskRe",
+ "type": "String",
+ "desc": "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "disableKeyFilter",
+ "type": "Boolean",
+ "desc": "True to disable input keystroke filtering (defaults to false)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "allowBlank",
+ "type": "Boolean",
+ "desc": "False to validate that the value length > 0 (defaults to true)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "minLength",
+ "type": "Number",
+ "desc": "Minimum input field length required (defaults to 0)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maxLength",
+ "type": "Number",
+ "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "minLengthText",
+ "type": "String",
+ "desc": "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maxLengthText",
+ "type": "String",
+ "desc": "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "selectOnFocus",
+ "type": "Boolean",
+ "desc": "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "blankText",
+ "type": "String",
+ "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "validator",
+ "type": "Function",
+ "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "regex",
+ "type": "RegExp",
+ "desc": "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "regexText",
+ "type": "String",
+ "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "emptyText",
+ "type": "String",
+ "desc": "The default text to display in an empty field (defaults to null).",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "emptyClass",
+ "type": "String",
+ "desc": "The CSS class to apply to an empty field to style the {@link #emptyText} (defaults to\n'x-form-empty-field'). This class is automatically added and removed as needed depending on the current field value.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "fieldLabel",
+ "type": "String",
+ "desc": "Label to use when rendering a form.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "qtip",
+ "type": "String",
+ "desc": "Mouse over tip",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "desc": "The field's HTML name attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationEvent",
+ "type": "String/Boolean",
+ "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validateOnBlur",
+ "type": "Boolean",
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "autoCreate",
+ "type": "String/Object",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgTarget",
+ "type": "String",
+ "desc": "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\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</pre>",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgFx",
+ "type": "String",
+ "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "True to disable the field (defaults to false).",
+ "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"
+ },
+ {
+ "name": "tabIndex",
+ "type": "Number",
+ "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "value",
+ "type": "Mixed",
+ "desc": "A value to initialize this field with.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "A CSS class to apply to the field's underlying element.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "width",
+ "type": "Number",
+ "desc": "width (optional) size of component",
+ "memberOf": "Roo.BoxComponent"
+ },
+ {
+ "name": "height",
+ "type": "Number",
+ "desc": "height (optional) size of component",
+ "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"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "autosize",
+ "sig": "function (_self, width)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "blur",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field loses input focus."
+ },
+ {
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires just before the field blurs if the field value has changed."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field receives input focus."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been marked as invalid."
+ },
+ {
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the key up"
+ },
+ {
+ "name": "move",
+ "sig": "function (_self, x, y)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is moved."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "resize",
+ "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is resized."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ },
+ {
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
+ }
+ ]
+ },
+ "Roo.form.Radio": {
+ "props": [
+ {
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the checkbox receives focus (defaults to undefined)",
+ "memberOf": "Roo.form.Checkbox"
+ },
+ {
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "memberOf": "Roo.form.Checkbox"
+ },
+ {
+ "name": "checked",
+ "type": "Boolean",
+ "desc": "True if the the checkbox should render already checked (defaults to false)",
+ "memberOf": "Roo.form.Checkbox"
+ },
+ {
+ "name": "autoCreate",
+ "type": "String/Object",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
+ "memberOf": "Roo.form.Checkbox"
+ },
+ {
+ "name": "boxLabel",
+ "type": "String",
+ "desc": "The text that appears beside the checkbox",
+ "memberOf": "Roo.form.Checkbox"
+ },
+ {
+ "name": "inputValue",
+ "type": "String",
+ "desc": "The value that should go into the generated input element's value attribute",
+ "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"
+ },
+ {
+ "name": "fieldLabel",
+ "type": "String",
+ "desc": "Label to use when rendering a form.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "qtip",
+ "type": "String",
+ "desc": "Mouse over tip",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "desc": "The field's HTML name attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationEvent",
+ "type": "String/Boolean",
+ "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validateOnBlur",
+ "type": "Boolean",
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgTarget",
+ "type": "String",
+ "desc": "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\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</pre>",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgFx",
+ "type": "String",
+ "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "True to disable the field (defaults to false).",
+ "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"
+ },
+ {
+ "name": "tabIndex",
+ "type": "Number",
+ "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "value",
+ "type": "Mixed",
+ "desc": "A value to initialize this field with.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "A CSS class to apply to the field's underlying element.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "width",
+ "type": "Number",
+ "desc": "width (optional) size of component",
+ "memberOf": "Roo.BoxComponent"
+ },
+ {
+ "name": "height",
+ "type": "Number",
+ "desc": "height (optional) size of component",
+ "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"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "blur",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field loses input focus."
+ },
+ {
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires just before the field blurs if the field value has changed."
+ },
+ {
+ "name": "check",
+ "sig": "function (_self, checked)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the checkbox is checked or unchecked."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field receives input focus."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been marked as invalid."
+ },
+ {
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the key up"
+ },
+ {
+ "name": "move",
+ "sig": "function (_self, x, y)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is moved."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "resize",
+ "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is resized."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ },
+ {
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
+ }
+ ]
+ },
+ "Roo.form.Row": {
+ "props": [
+ {
+ "name": "width",
+ "type": "Number/String",
+ "desc": "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
+ "memberOf": ""
+ },
+ {
+ "name": "height",
+ "type": "Number/String",
+ "desc": "The fixed height of the column in pixels or CSS value (defaults to \"auto\")",
+ "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"
+ },
+ {
+ "name": "style",
+ "type": "String/Object/Function",
+ "desc": "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
+ "memberOf": "Roo.form.Layout"
+ },
+ {
+ "name": "labelAlign",
+ "type": "String",
+ "desc": "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
+ "memberOf": "Roo.form.Layout"
+ },
+ {
+ "name": "labelWidth",
+ "type": "Number",
+ "desc": "Fixed width in pixels of all field labels (defaults to undefined)",
+ "memberOf": "Roo.form.Layout"
+ },
+ {
+ "name": "clear",
+ "type": "Boolean",
+ "desc": "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
+ "memberOf": "Roo.form.Layout"
+ },
+ {
+ "name": "labelSeparator",
+ "type": "String",
+ "desc": "The separator to use after field labels (defaults to ':')",
+ "memberOf": "Roo.form.Layout"
+ },
+ {
+ "name": "hideLabels",
+ "type": "Boolean",
+ "desc": "True to suppress the display of field labels in this layout (defaults to false)",
+ "memberOf": "Roo.form.Layout"
+ },
+ {
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ }
+ ]
+ },
+ "Roo.form.TextArea": {
+ "props": [
+ {
+ "name": "growMin",
+ "type": "Number",
+ "desc": "The minimum height to allow when grow = true (defaults to 60)",
+ "memberOf": ""
+ },
+ {
+ "name": "growMax",
+ "type": "Number",
+ "desc": "The maximum height to allow when grow = true (defaults to 1000)",
+ "memberOf": ""
+ },
+ {
+ "name": "preventScrollbars",
+ "type": "Boolean",
+ "desc": "True to prevent scrollbars from appearing regardless of how much text is\nin the field (equivalent to setting overflow: hidden, defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "autoCreate",
+ "type": "String/Object",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"textarea\", style: \"width:300px;height:60px;\", autocomplete: \"off\"})",
+ "memberOf": ""
+ },
+ {
+ "name": "grow",
+ "type": "Boolean",
+ "desc": "True if this field should automatically grow and shrink to its content",
+ "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"
+ },
+ {
+ "name": "maskRe",
+ "type": "String",
+ "desc": "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "disableKeyFilter",
+ "type": "Boolean",
+ "desc": "True to disable input keystroke filtering (defaults to false)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "allowBlank",
+ "type": "Boolean",
+ "desc": "False to validate that the value length > 0 (defaults to true)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "minLength",
+ "type": "Number",
+ "desc": "Minimum input field length required (defaults to 0)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maxLength",
+ "type": "Number",
+ "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "minLengthText",
+ "type": "String",
+ "desc": "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maxLengthText",
+ "type": "String",
+ "desc": "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "selectOnFocus",
+ "type": "Boolean",
+ "desc": "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "blankText",
+ "type": "String",
+ "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "validator",
+ "type": "Function",
+ "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "regex",
+ "type": "RegExp",
+ "desc": "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "regexText",
+ "type": "String",
+ "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "emptyText",
+ "type": "String",
+ "desc": "The default text to display in an empty field (defaults to null).",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "emptyClass",
+ "type": "String",
+ "desc": "The CSS class to apply to an empty field to style the {@link #emptyText} (defaults to\n'x-form-empty-field'). This class is automatically added and removed as needed depending on the current field value.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "fieldLabel",
+ "type": "String",
+ "desc": "Label to use when rendering a form.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "qtip",
+ "type": "String",
+ "desc": "Mouse over tip",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "desc": "The field's HTML name attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationEvent",
+ "type": "String/Boolean",
+ "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validateOnBlur",
+ "type": "Boolean",
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the field (defaults to \"x-form-field\")",
+ "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<pre>\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</pre>",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgFx",
+ "type": "String",
+ "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "True to disable the field (defaults to false).",
+ "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"
+ },
+ {
+ "name": "tabIndex",
+ "type": "Number",
+ "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "value",
+ "type": "Mixed",
+ "desc": "A value to initialize this field with.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "A CSS class to apply to the field's underlying element.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "width",
+ "type": "Number",
+ "desc": "width (optional) size of component",
+ "memberOf": "Roo.BoxComponent"
+ },
+ {
+ "name": "height",
+ "type": "Number",
+ "desc": "height (optional) size of component",
+ "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"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "autosize",
+ "sig": "function (_self, width)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "blur",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field loses input focus."
+ },
+ {
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires just before the field blurs if the field value has changed."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field receives input focus."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been marked as invalid."
+ },
+ {
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the key up"
+ },
+ {
+ "name": "move",
+ "sig": "function (_self, x, y)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is moved."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "resize",
+ "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is resized."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ },
+ {
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
+ }
+ ]
+ },
+ "Roo.form.TextField": {
+ "props": [
+ {
+ "name": "grow",
+ "type": "Boolean",
+ "desc": "True if this field should automatically grow and shrink to its content",
+ "memberOf": ""
+ },
+ {
+ "name": "growMin",
+ "type": "Number",
+ "desc": "The minimum width to allow when grow = true (defaults to 30)",
+ "memberOf": ""
+ },
+ {
+ "name": "growMax",
+ "type": "Number",
+ "desc": "The maximum width to allow when grow = true (defaults to 800)",
+ "memberOf": ""
+ },
+ {
+ "name": "vtype",
+ "type": "String",
+ "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "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": ""
+ },
+ {
+ "name": "disableKeyFilter",
+ "type": "Boolean",
+ "desc": "True to disable input keystroke filtering (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "allowBlank",
+ "type": "Boolean",
+ "desc": "False to validate that the value length > 0 (defaults to true)",
+ "memberOf": ""
+ },
+ {
+ "name": "minLength",
+ "type": "Number",
+ "desc": "Minimum input field length required (defaults to 0)",
+ "memberOf": ""
+ },
+ {
+ "name": "maxLength",
+ "type": "Number",
+ "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf": ""
+ },
+ {
+ "name": "minLengthText",
+ "type": "String",
+ "desc": "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf": ""
+ },
+ {
+ "name": "maxLengthText",
+ "type": "String",
+ "desc": "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf": ""
+ },
+ {
+ "name": "selectOnFocus",
+ "type": "Boolean",
+ "desc": "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "blankText",
+ "type": "String",
+ "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf": ""
+ },
+ {
+ "name": "validator",
+ "type": "Function",
+ "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf": ""
+ },
+ {
+ "name": "regex",
+ "type": "RegExp",
+ "desc": "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf": ""
+ },
+ {
+ "name": "regexText",
+ "type": "String",
+ "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf": ""
+ },
+ {
+ "name": "emptyText",
+ "type": "String",
+ "desc": "The default text to display in an empty field (defaults to null).",
+ "memberOf": ""
+ },
+ {
+ "name": "emptyClass",
+ "type": "String",
+ "desc": "The CSS class to apply to an empty field to style the {@link #emptyText} (defaults to\n'x-form-empty-field'). This class is automatically added and removed as needed depending on the current field value.",
+ "memberOf": ""
+ },
+ {
+ "name": "fieldLabel",
+ "type": "String",
+ "desc": "Label to use when rendering a form.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "qtip",
+ "type": "String",
+ "desc": "Mouse over tip",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "desc": "The field's HTML name attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationEvent",
+ "type": "String/Boolean",
+ "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validateOnBlur",
+ "type": "Boolean",
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "autoCreate",
+ "type": "String/Object",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the field (defaults to \"x-form-field\")",
+ "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<pre>\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</pre>",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgFx",
+ "type": "String",
+ "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "True to disable the field (defaults to false).",
+ "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"
+ },
+ {
+ "name": "tabIndex",
+ "type": "Number",
+ "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "value",
+ "type": "Mixed",
+ "desc": "A value to initialize this field with.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "A CSS class to apply to the field's underlying element.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "width",
+ "type": "Number",
+ "desc": "width (optional) size of component",
+ "memberOf": "Roo.BoxComponent"
+ },
+ {
+ "name": "height",
+ "type": "Number",
+ "desc": "height (optional) size of component",
+ "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"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "autosize",
+ "sig": "function (_self, width)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "blur",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field loses input focus."
+ },
+ {
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires just before the field blurs if the field value has changed."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field receives input focus."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been marked as invalid."
+ },
+ {
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the key up"
+ },
+ {
+ "name": "move",
+ "sig": "function (_self, x, y)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is moved."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "resize",
+ "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is resized."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ },
+ {
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
+ }
+ ]
+ },
+ "Roo.form.TriggerField": {
+ "props": [
+ {
+ "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 <b>appended</b> if specified.",
+ "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: \"16\", autocomplete: \"off\"})",
+ "memberOf": ""
+ },
+ {
+ "name": "hideTrigger",
+ "type": "Boolean",
+ "desc": "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "vtype",
+ "type": "String",
+ "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maskRe",
+ "type": "String",
+ "desc": "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "disableKeyFilter",
+ "type": "Boolean",
+ "desc": "True to disable input keystroke filtering (defaults to false)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "allowBlank",
+ "type": "Boolean",
+ "desc": "False to validate that the value length > 0 (defaults to true)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "minLength",
+ "type": "Number",
+ "desc": "Minimum input field length required (defaults to 0)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maxLength",
+ "type": "Number",
+ "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "minLengthText",
+ "type": "String",
+ "desc": "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maxLengthText",
+ "type": "String",
+ "desc": "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "selectOnFocus",
+ "type": "Boolean",
+ "desc": "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "blankText",
+ "type": "String",
+ "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "validator",
+ "type": "Function",
+ "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "regex",
+ "type": "RegExp",
+ "desc": "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "regexText",
+ "type": "String",
+ "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "emptyText",
+ "type": "String",
+ "desc": "The default text to display in an empty field (defaults to null).",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "emptyClass",
+ "type": "String",
+ "desc": "The CSS class to apply to an empty field to style the {@link #emptyText} (defaults to\n'x-form-empty-field'). This class is automatically added and removed as needed depending on the current field value.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "fieldLabel",
+ "type": "String",
+ "desc": "Label to use when rendering a form.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "qtip",
+ "type": "String",
+ "desc": "Mouse over tip",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "name",
+ "type": "String",
+ "desc": "The field's HTML name attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationEvent",
+ "type": "String/Boolean",
+ "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validateOnBlur",
+ "type": "Boolean",
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the field (defaults to \"x-form-field\")",
+ "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<pre>\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</pre>",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgFx",
+ "type": "String",
+ "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "True to disable the field (defaults to false).",
+ "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"
+ },
+ {
+ "name": "tabIndex",
+ "type": "Number",
+ "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "value",
+ "type": "Mixed",
+ "desc": "A value to initialize this field with.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "A CSS class to apply to the field's underlying element.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "width",
+ "type": "Number",
+ "desc": "width (optional) size of component",
+ "memberOf": "Roo.BoxComponent"
+ },
+ {
+ "name": "height",
+ "type": "Number",
+ "desc": "height (optional) size of component",
+ "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"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "autosize",
+ "sig": "function (_self, width)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "blur",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field loses input focus."
+ },
+ {
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires just before the field blurs if the field value has changed."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field receives input focus."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been marked as invalid."
+ },
+ {
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the key up"
+ },
+ {
+ "name": "move",
+ "sig": "function (_self, x, y)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is moved."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "resize",
+ "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is resized."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ },
+ {
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
+ }
+ ]
+ },
+ "Roo.form.VTypes": {
+ "props": [],
+ "events": []
+ },
+ "Roo.grid": {
+ "props": [],
+ "events": []
+ },
+ "Roo.grid.AbstractGridView": {
+ "props": [],
+ "events": []
+ },
+ "Roo.grid.AbstractSelectionModel": {
+ "props": [
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": []
+ },
+ "Roo.grid.CellSelectionModel": {
+ "props": [
+ {
+ "name": "enter_is_tab",
+ "type": "Boolean",
+ "desc": "Enter behaves the same as tab. (eg. goes to next cell) default: false",
+ "memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforerowselect",
+ "sig": "function (_self, rowIndex, colIndex)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a cell is selected."
+ },
+ {
+ "name": "cellselect",
+ "sig": "function (_self, rowIndex, colIndex)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a cell is selected."
+ },
+ {
+ "name": "selectionchange",
+ "sig": "function (_self, selection)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the active selection changes."
+ },
+ {
+ "name": "tabend",
+ "sig": "function (_self)\n{\n\n}",
+ "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."
+ }
+ ]
+ },
+ "Roo.grid.ColumnModel": {
+ "props": [
+ {
+ "name": "header",
+ "type": "String",
+ "desc": "The header text to display in the Grid view.",
+ "memberOf": ""
+ },
+ {
+ "name": "dataIndex",
+ "type": "String",
+ "desc": "(Optional) The name of the field in the grid's {@link Roo.data.Store}'s\n{@link Roo.data.Record} definition from which to draw the column's value. If not\nspecified, the column's index is used as an index into the Record's data Array.",
+ "memberOf": ""
+ },
+ {
+ "name": "width",
+ "type": "Number",
+ "desc": "(Optional) The initial width in pixels of the column. Using this\ninstead of {@link Roo.grid.Grid#autoSizeColumns} is more efficient.",
+ "memberOf": ""
+ },
+ {
+ "name": "sortable",
+ "type": "Boolean",
+ "desc": "(Optional) True if sorting is to be allowed on this column.\nDefaults to the value of the {@link #defaultSortable} property.\nWhether local/remote sorting is used is specified in {@link Roo.data.Store#remoteSort}.",
+ "memberOf": ""
+ },
+ {
+ "name": "locked",
+ "type": "Boolean",
+ "desc": "(Optional) True to lock the column in place while scrolling the Grid. Defaults to false.",
+ "memberOf": ""
+ },
+ {
+ "name": "fixed",
+ "type": "Boolean",
+ "desc": "(Optional) True if the column width cannot be changed. Defaults to false.",
+ "memberOf": ""
+ },
+ {
+ "name": "resizable",
+ "type": "Boolean",
+ "desc": "(Optional) False to disable column resizing. Defaults to true.",
+ "memberOf": ""
+ },
+ {
+ "name": "hidden",
+ "type": "Boolean",
+ "desc": "(Optional) True to hide the column. Defaults to false.",
+ "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 uses the raw data value.",
+ "memberOf": ""
+ },
+ {
+ "name": "editor",
+ "type": "Roo.grid.GridEditor",
+ "desc": "(Optional) For grid editors - returns the grid editor",
+ "memberOf": ""
+ },
+ {
+ "name": "align",
+ "type": "String",
+ "desc": "(Optional) Set the CSS text-align property of the column. Defaults to undefined.",
+ "memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "columlockchange",
+ "sig": "function (_self, colIndex, locked)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a column's locked state is changed"
+ },
+ {
+ "name": "columnmoved",
+ "sig": "function (_self, oldIndex, newIndex)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a column is moved."
+ },
+ {
+ "name": "headerchange",
+ "sig": "function (_self, columnIndex, newText)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the text of a header changes."
+ },
+ {
+ "name": "hiddenchange",
+ "sig": "function (_self, columnIndex, hidden)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a column is hidden or \"unhidden\"."
+ },
+ {
+ "name": "widthchange",
+ "sig": "function (_self, columnIndex, newWidth)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the width of a column changes."
+ }
+ ]
+ },
+ "Roo.grid.EditorGrid": {
+ "props": [
+ {
+ "name": "clicksToEdit",
+ "type": "Number",
+ "desc": "The number of clicks on a cell required to display the cell's editor (defaults to 2)",
+ "memberOf": ""
+ },
+ {
+ "name": "ddGroup",
+ "type": "String",
+ "desc": "- drag drop group.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "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"
+ },
+ {
+ "name": "maxHeight",
+ "type": "Number",
+ "desc": "Sets the maximum height of the grid - ignored if autoHeight is not on.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "minColumnWidth",
+ "type": "Number",
+ "desc": "The minimum width a column can be resized to. Default is 25.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "autoSizeColumns",
+ "type": "Boolean",
+ "desc": "True to automatically resize the columns to fit their content\n<b>on initial render.</b> It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "autoSizeHeaders",
+ "type": "Boolean",
+ "desc": "True to measure headers with column data when auto sizing columns. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "monitorWindowResize",
+ "type": "Boolean",
+ "desc": "True to autoSize the grid when the window resizes. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "maxRowsToMeasure",
+ "type": "Boolean",
+ "desc": "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "trackMouseOver",
+ "type": "Boolean",
+ "desc": "True to highlight rows when the mouse is over. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "enableDragDrop",
+ "type": "Boolean",
+ "desc": "True to enable drag and drop of rows. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "enableColumnMove",
+ "type": "Boolean",
+ "desc": "True to enable drag and drop reorder of columns. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "enableColumnHide",
+ "type": "Boolean",
+ "desc": "True to enable hiding of columns with the header context menu. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "enableRowHeightSync",
+ "type": "Boolean",
+ "desc": "True to manually sync row heights across locked and not locked rows. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "stripeRows",
+ "type": "Boolean",
+ "desc": "True to stripe the rows. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "autoHeight",
+ "type": "Boolean",
+ "desc": "True to fit the height of the grid container to the height of the data. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "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": "autoExpandMin",
+ "type": "Number",
+ "desc": "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "autoExpandMax",
+ "type": "Number",
+ "desc": "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "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"
+ },
+ {
+ "name": "loadMask",
+ "type": "Object",
+ "desc": "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "dragTarget",
+ "type": "Roo.dd.DropTarget",
+ "desc": "An {@link Roo.dd.DragTarget} config",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "afteredit",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after a cell is edited. <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n</ul>"
+ },
+ {
+ "name": "beforeedit",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before cell editing is triggered. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value for the field being edited.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>"
+ },
+ {
+ "name": "bodyscroll",
+ "sig": "function (scrollLeft, scrollTop)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the body element is scrolled"
+ },
+ {
+ "name": "cellclick",
+ "sig": "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a cell is clicked"
+ },
+ {
+ "name": "cellcontextmenu",
+ "sig": "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a cell is right clicked"
+ },
+ {
+ "name": "celldblclick",
+ "sig": "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a cell is double clicked"
+ },
+ {
+ "name": "click",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw click event for the entire grid."
+ },
+ {
+ "name": "columnmove",
+ "sig": "function (oldIndex, newIndex)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the user moves a column"
+ },
+ {
+ "name": "columnresize",
+ "sig": "function (columnIndex, newSize)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the user resizes a column"
+ },
+ {
+ "name": "contextmenu",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw contextmenu event for the entire grid."
+ },
+ {
+ "name": "dblclick",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw dblclick event for the entire grid."
+ },
+ {
+ "name": "dragdrop",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when dragged row(s) are dropped on a valid DD target"
+ },
+ {
+ "name": "dragenter\n Fires when the dragged row(s) first cross another DD target while being dragged",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "type": "function",
+ "desc": ""
+ },
+ {
+ "name": "dragout",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the dragged row(s) leave another DD target while being dragged"
+ },
+ {
+ "name": "dragover",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "enddrag",
+ "sig": "function (_self, dd, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a drag operation is complete"
+ },
+ {
+ "name": "headerclick",
+ "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a header is clicked"
+ },
+ {
+ "name": "headercontextmenu",
+ "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a header is right clicked"
+ },
+ {
+ "name": "headerdblclick",
+ "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a header cell is double clicked"
+ },
+ {
+ "name": "keydown",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw keydown event for the entire grid."
+ },
+ {
+ "name": "keypress",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw keypress event for the entire grid."
+ },
+ {
+ "name": "mousedown",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mousedown event for the entire grid."
+ },
+ {
+ "name": "mouseout",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mouseout event for the entire grid."
+ },
+ {
+ "name": "mouseover",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mouseover event for the entire grid."
+ },
+ {
+ "name": "mouseup",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mouseup event for the entire grid."
+ },
+ {
+ "name": "render",
+ "sig": "function (grid)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the grid is rendered"
+ },
+ {
+ "name": "rowclass",
+ "sig": "function (gridview, rowcfg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is rendered, so you can change add a style to it."
+ },
+ {
+ "name": "rowclick",
+ "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is clicked"
+ },
+ {
+ "name": "rowcontextmenu",
+ "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is right clicked"
+ },
+ {
+ "name": "rowdblclick",
+ "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is double clicked"
+ },
+ {
+ "name": "startdrag",
+ "sig": "function (_self, dd, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when row(s) start being dragged"
+ },
+ {
+ "name": "validateedit",
+ "sig": "function (e)\n{\n\n}",
+ "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 <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>editor - This editor</li>\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>"
+ }
+ ]
+ },
+ "Roo.grid.Grid": {
+ "props": [
+ {
+ "name": "ddGroup",
+ "type": "String",
+ "desc": "- drag drop group.",
+ "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": ""
+ },
+ {
+ "name": "maxHeight",
+ "type": "Number",
+ "desc": "Sets the maximum height of the grid - ignored if autoHeight is not on.",
+ "memberOf": ""
+ },
+ {
+ "name": "minColumnWidth",
+ "type": "Number",
+ "desc": "The minimum width a column can be resized to. Default is 25.",
+ "memberOf": ""
+ },
+ {
+ "name": "autoSizeColumns",
+ "type": "Boolean",
+ "desc": "True to automatically resize the columns to fit their content\n<b>on initial render.</b> It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.",
+ "memberOf": ""
+ },
+ {
+ "name": "autoSizeHeaders",
+ "type": "Boolean",
+ "desc": "True to measure headers with column data when auto sizing columns. Default is true.",
+ "memberOf": ""
+ },
+ {
+ "name": "monitorWindowResize",
+ "type": "Boolean",
+ "desc": "True to autoSize the grid when the window resizes. Default is true.",
+ "memberOf": ""
+ },
+ {
+ "name": "maxRowsToMeasure",
+ "type": "Boolean",
+ "desc": "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
+ "memberOf": ""
+ },
+ {
+ "name": "trackMouseOver",
+ "type": "Boolean",
+ "desc": "True to highlight rows when the mouse is over. Default is true.",
+ "memberOf": ""
+ },
+ {
+ "name": "enableDragDrop",
+ "type": "Boolean",
+ "desc": "True to enable drag and drop of rows. Default is false.",
+ "memberOf": ""
+ },
+ {
+ "name": "enableColumnMove",
+ "type": "Boolean",
+ "desc": "True to enable drag and drop reorder of columns. Default is true.",
+ "memberOf": ""
+ },
+ {
+ "name": "enableColumnHide",
+ "type": "Boolean",
+ "desc": "True to enable hiding of columns with the header context menu. Default is true.",
+ "memberOf": ""
+ },
+ {
+ "name": "enableRowHeightSync",
+ "type": "Boolean",
+ "desc": "True to manually sync row heights across locked and not locked rows. Default is false.",
+ "memberOf": ""
+ },
+ {
+ "name": "stripeRows",
+ "type": "Boolean",
+ "desc": "True to stripe the rows. Default is true.",
+ "memberOf": ""
+ },
+ {
+ "name": "autoHeight",
+ "type": "Boolean",
+ "desc": "True to fit the height of the grid container to the height of the data. Default is false.",
+ "memberOf": ""
+ },
+ {
+ "name": "autoExpandColumn",
+ "type": "String",
+ "desc": "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
+ "memberOf": ""
+ },
+ {
+ "name": "autoExpandMin",
+ "type": "Number",
+ "desc": "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
+ "memberOf": ""
+ },
+ {
+ "name": "autoExpandMax",
+ "type": "Number",
+ "desc": "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
+ "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": ""
+ },
+ {
+ "name": "loadMask",
+ "type": "Object",
+ "desc": "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
+ "memberOf": ""
+ },
+ {
+ "name": "dragTarget",
+ "type": "Roo.dd.DropTarget",
+ "desc": "An {@link Roo.dd.DragTarget} config",
+ "memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "bodyscroll",
+ "sig": "function (scrollLeft, scrollTop)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the body element is scrolled"
+ },
+ {
+ "name": "cellclick",
+ "sig": "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a cell is clicked"
+ },
+ {
+ "name": "cellcontextmenu",
+ "sig": "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a cell is right clicked"
+ },
+ {
+ "name": "celldblclick",
+ "sig": "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a cell is double clicked"
+ },
+ {
+ "name": "click",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw click event for the entire grid."
+ },
+ {
+ "name": "columnmove",
+ "sig": "function (oldIndex, newIndex)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the user moves a column"
+ },
+ {
+ "name": "columnresize",
+ "sig": "function (columnIndex, newSize)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the user resizes a column"
+ },
+ {
+ "name": "contextmenu",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw contextmenu event for the entire grid."
+ },
+ {
+ "name": "dblclick",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw dblclick event for the entire grid."
+ },
+ {
+ "name": "dragdrop",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when dragged row(s) are dropped on a valid DD target"
+ },
+ {
+ "name": "dragenter\n Fires when the dragged row(s) first cross another DD target while being dragged",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "type": "function",
+ "desc": ""
+ },
+ {
+ "name": "dragout",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the dragged row(s) leave another DD target while being dragged"
+ },
+ {
+ "name": "dragover",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "enddrag",
+ "sig": "function (_self, dd, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a drag operation is complete"
+ },
+ {
+ "name": "headerclick",
+ "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a header is clicked"
+ },
+ {
+ "name": "headercontextmenu",
+ "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a header is right clicked"
+ },
+ {
+ "name": "headerdblclick",
+ "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a header cell is double clicked"
+ },
+ {
+ "name": "keydown",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw keydown event for the entire grid."
+ },
+ {
+ "name": "keypress",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw keypress event for the entire grid."
+ },
+ {
+ "name": "mousedown",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mousedown event for the entire grid."
+ },
+ {
+ "name": "mouseout",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mouseout event for the entire grid."
+ },
+ {
+ "name": "mouseover",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mouseover event for the entire grid."
+ },
+ {
+ "name": "mouseup",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mouseup event for the entire grid."
+ },
+ {
+ "name": "render",
+ "sig": "function (grid)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the grid is rendered"
+ },
+ {
+ "name": "rowclass",
+ "sig": "function (gridview, rowcfg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is rendered, so you can change add a style to it."
+ },
+ {
+ "name": "rowclick",
+ "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is clicked"
+ },
+ {
+ "name": "rowcontextmenu",
+ "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is right clicked"
+ },
+ {
+ "name": "rowdblclick",
+ "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is double clicked"
+ },
+ {
+ "name": "startdrag",
+ "sig": "function (_self, dd, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when row(s) start being dragged"
+ }
+ ]
+ },
+ "Roo.grid.GridEditor": {
+ "props": [
+ {
+ "name": "field",
+ "type": "Roo.form.Field",
+ "desc": "Field to wrap (or xtyped)",
+ "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"
+ },
+ {
+ "name": "revertInvalid",
+ "type": "Boolean",
+ "desc": "True to automatically revert the field value and cancel the edit when the user completes an edit and the field\nvalidation fails (defaults to true)",
+ "memberOf": "Roo.Editor"
+ },
+ {
+ "name": "ignoreNoChange",
+ "type": "Boolean",
+ "desc": "True to skip the the edit completion process (no save, no events fired) if the user completes an edit and\nthe value has not changed (defaults to false). Applies only to string values - edits for other data types\nwill never be ignored.",
+ "memberOf": "Roo.Editor"
+ },
+ {
+ "name": "hideEl",
+ "type": "Boolean",
+ "desc": "False to keep the bound element visible while the editor is displayed (defaults to true)",
+ "memberOf": "Roo.Editor"
+ },
+ {
+ "name": "value",
+ "type": "Mixed",
+ "desc": "The data value of the underlying field (defaults to \"\")",
+ "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"
+ },
+ {
+ "name": "shadow",
+ "type": "Boolean/String",
+ "desc": "\"sides\" for sides/bottom only, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"frame\")",
+ "memberOf": "Roo.Editor"
+ },
+ {
+ "name": "constrain",
+ "type": "Boolean",
+ "desc": "True to constrain the editor to the viewport",
+ "memberOf": "Roo.Editor"
+ },
+ {
+ "name": "completeOnEnter",
+ "type": "Boolean",
+ "desc": "True to complete the edit when the enter key is pressed (defaults to false)",
+ "memberOf": "Roo.Editor"
+ },
+ {
+ "name": "cancelOnEsc",
+ "type": "Boolean",
+ "desc": "True to cancel the edit when the escape key is pressed (defaults to false)",
+ "memberOf": "Roo.Editor"
+ },
+ {
+ "name": "updateEl",
+ "type": "Boolean",
+ "desc": "True to update the innerHTML of the bound element when the update completes (defaults to false)",
+ "memberOf": "Roo.Editor"
+ },
+ {
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforecomplete",
+ "sig": "function (_self, value, startValue)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "beforestartedit",
+ "sig": "function (_self, boundEl, value)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "complete",
+ "sig": "function (_self, value, startValue)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after editing is complete and any changed value has been written to the underlying field."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ },
+ {
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "startedit",
+ "sig": "function (boundEl, value)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this editor is displayed"
+ }
+ ]
+ },
+ "Roo.grid.GridView": {
+ "props": [
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": []
+ },
+ "Roo.grid.PropertyGrid": {
+ "props": [
+ {
+ "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": "propertyNames",
+ "type": "Object",
+ "desc": "map of property Names to their displayed value",
+ "memberOf": ""
+ },
+ {
+ "name": "clicksToEdit",
+ "type": "Number",
+ "desc": "The number of clicks on a cell required to display the cell's editor (defaults to 2)",
+ "memberOf": "Roo.grid.EditorGrid"
+ },
+ {
+ "name": "ddGroup",
+ "type": "String",
+ "desc": "- drag drop group.",
+ "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"
+ },
+ {
+ "name": "maxHeight",
+ "type": "Number",
+ "desc": "Sets the maximum height of the grid - ignored if autoHeight is not on.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "minColumnWidth",
+ "type": "Number",
+ "desc": "The minimum width a column can be resized to. Default is 25.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "autoSizeColumns",
+ "type": "Boolean",
+ "desc": "True to automatically resize the columns to fit their content\n<b>on initial render.</b> It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "autoSizeHeaders",
+ "type": "Boolean",
+ "desc": "True to measure headers with column data when auto sizing columns. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "monitorWindowResize",
+ "type": "Boolean",
+ "desc": "True to autoSize the grid when the window resizes. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "maxRowsToMeasure",
+ "type": "Boolean",
+ "desc": "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "trackMouseOver",
+ "type": "Boolean",
+ "desc": "True to highlight rows when the mouse is over. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "enableDragDrop",
+ "type": "Boolean",
+ "desc": "True to enable drag and drop of rows. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "enableColumnMove",
+ "type": "Boolean",
+ "desc": "True to enable drag and drop reorder of columns. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "enableColumnHide",
+ "type": "Boolean",
+ "desc": "True to enable hiding of columns with the header context menu. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "enableRowHeightSync",
+ "type": "Boolean",
+ "desc": "True to manually sync row heights across locked and not locked rows. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "stripeRows",
+ "type": "Boolean",
+ "desc": "True to stripe the rows. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "autoHeight",
+ "type": "Boolean",
+ "desc": "True to fit the height of the grid container to the height of the data. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "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": "autoExpandMin",
+ "type": "Number",
+ "desc": "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "autoExpandMax",
+ "type": "Number",
+ "desc": "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "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"
+ },
+ {
+ "name": "loadMask",
+ "type": "Object",
+ "desc": "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "dragTarget",
+ "type": "Roo.dd.DropTarget",
+ "desc": "An {@link Roo.dd.DragTarget} config",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "afteredit",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after a cell is edited. <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n</ul>"
+ },
+ {
+ "name": "beforeedit",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before cell editing is triggered. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value for the field being edited.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>"
+ },
+ {
+ "name": "beforepropertychange",
+ "sig": "function (grid, id, newval, oldval)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a property changes (return false to stop?)"
+ },
+ {
+ "name": "bodyscroll",
+ "sig": "function (scrollLeft, scrollTop)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the body element is scrolled"
+ },
+ {
+ "name": "cellclick",
+ "sig": "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a cell is clicked"
+ },
+ {
+ "name": "cellcontextmenu",
+ "sig": "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a cell is right clicked"
+ },
+ {
+ "name": "celldblclick",
+ "sig": "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a cell is double clicked"
+ },
+ {
+ "name": "click",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw click event for the entire grid."
+ },
+ {
+ "name": "columnmove",
+ "sig": "function (oldIndex, newIndex)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the user moves a column"
+ },
+ {
+ "name": "columnresize",
+ "sig": "function (columnIndex, newSize)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the user resizes a column"
+ },
+ {
+ "name": "contextmenu",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw contextmenu event for the entire grid."
+ },
+ {
+ "name": "dblclick",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw dblclick event for the entire grid."
+ },
+ {
+ "name": "dragdrop",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when dragged row(s) are dropped on a valid DD target"
+ },
+ {
+ "name": "dragenter\n Fires when the dragged row(s) first cross another DD target while being dragged",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "type": "function",
+ "desc": ""
+ },
+ {
+ "name": "dragout",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the dragged row(s) leave another DD target while being dragged"
+ },
+ {
+ "name": "dragover",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "enddrag",
+ "sig": "function (_self, dd, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a drag operation is complete"
+ },
+ {
+ "name": "headerclick",
+ "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a header is clicked"
+ },
+ {
+ "name": "headercontextmenu",
+ "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a header is right clicked"
+ },
+ {
+ "name": "headerdblclick",
+ "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a header cell is double clicked"
+ },
+ {
+ "name": "keydown",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw keydown event for the entire grid."
+ },
+ {
+ "name": "keypress",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw keypress event for the entire grid."
+ },
+ {
+ "name": "mousedown",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mousedown event for the entire grid."
+ },
+ {
+ "name": "mouseout",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mouseout event for the entire grid."
+ },
+ {
+ "name": "mouseover",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mouseover event for the entire grid."
+ },
+ {
+ "name": "mouseup",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mouseup event for the entire grid."
+ },
+ {
+ "name": "propertychange",
+ "sig": "function (grid, id, newval, oldval)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after a property changes"
+ },
+ {
+ "name": "render",
+ "sig": "function (grid)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the grid is rendered"
+ },
+ {
+ "name": "rowclass",
+ "sig": "function (gridview, rowcfg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is rendered, so you can change add a style to it."
+ },
+ {
+ "name": "rowclick",
+ "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is clicked"
+ },
+ {
+ "name": "rowcontextmenu",
+ "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is right clicked"
+ },
+ {
+ "name": "rowdblclick",
+ "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is double clicked"
+ },
+ {
+ "name": "startdrag",
+ "sig": "function (_self, dd, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when row(s) start being dragged"
+ },
+ {
+ "name": "validateedit",
+ "sig": "function (e)\n{\n\n}",
+ "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 <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>editor - This editor</li>\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>"
+ }
+ ]
+ },
+ "Roo.grid.RowSelectionModel": {
+ "props": [
+ {
+ "name": "singleSelect",
+ "type": "Boolean",
+ "desc": "True to allow selection of only one row at a time (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "afterselectionchange",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the selection changes (eg. by key press or clicking)"
+ },
+ {
+ "name": "beforerowselect",
+ "sig": "function (_self, rowIndex, keepExisting)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is selected being selected, return false to cancel."
+ },
+ {
+ "name": "rowdeselect",
+ "sig": "function (_self, rowIndex)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is deselected."
+ },
+ {
+ "name": "rowselect",
+ "sig": "function (_self, rowIndex, r)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is selected."
+ },
+ {
+ "name": "selectionchange",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the selection changes"
+ }
+ ]
+ },
+ "Roo.lib": {
+ "props": [],
+ "events": []
+ },
+ "Roo.lib.Ajax": {
+ "props": [],
+ "events": []
+ },
+ "Roo.menu": {
+ "props": [],
+ "events": []
+ },
+ "Roo.menu.Adapter": {
+ "props": [
+ {
+ "name": "handler",
+ "type": "Function",
+ "desc": "A function that will handle the click event of this menu item (defaults to undefined)",
+ "memberOf": "Roo.menu.BaseItem"
+ },
+ {
+ "name": "canActivate",
+ "type": "Boolean",
+ "desc": "True if this item can be visually activated (defaults to false)",
+ "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"
+ },
+ {
+ "name": "hideOnClick",
+ "type": "Boolean",
+ "desc": "True to hide the containing menu after this item is clicked (defaults to true)",
+ "memberOf": "Roo.menu.BaseItem"
+ },
+ {
+ "name": "hideDelay",
+ "type": "Number",
+ "desc": "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
+ "memberOf": "Roo.menu.BaseItem"
+ },
+ {
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "activate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this item is activated"
+ },
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "click",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this item is clicked"
+ },
+ {
+ "name": "deactivate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this item is deactivated"
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ }
+ ]
+ },
+ "Roo.menu.BaseItem": {
+ "props": [
+ {
+ "name": "handler",
+ "type": "Function",
+ "desc": "A function that will handle the click event of this menu item (defaults to undefined)",
+ "memberOf": ""
+ },
+ {
+ "name": "canActivate",
+ "type": "Boolean",
+ "desc": "True if this item can be visually activated (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "activeClass",
+ "type": "String",
+ "desc": "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
+ "memberOf": ""
+ },
+ {
+ "name": "hideOnClick",
+ "type": "Boolean",
+ "desc": "True to hide the containing menu after this item is clicked (defaults to true)",
+ "memberOf": ""
+ },
+ {
+ "name": "hideDelay",
+ "type": "Number",
+ "desc": "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
+ "memberOf": ""
+ },
+ {
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "activate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this item is activated"
+ },
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "click",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this item is clicked"
+ },
+ {
+ "name": "deactivate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this item is deactivated"
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ }
+ ]
+ },
+ "Roo.menu.CheckItem": {
+ "props": [
+ {
+ "name": "group",
+ "type": "String",
+ "desc": "All check items with the same group name will automatically be grouped into a single-select\nradio button group (defaults to '')",
+ "memberOf": ""
+ },
+ {
+ "name": "itemCls",
+ "type": "String",
+ "desc": "The default CSS class to use for check items (defaults to \"x-menu-item x-menu-check-item\")",
+ "memberOf": ""
+ },
+ {
+ "name": "groupClass",
+ "type": "String",
+ "desc": "The default CSS class to use for radio group check items (defaults to \"x-menu-group-item\")",
+ "memberOf": ""
+ },
+ {
+ "name": "checked",
+ "type": "Boolean",
+ "desc": "True to initialize this checkbox as checked (defaults to false). Note that\nif this checkbox is part of a radio group (group = true) only the last item in the group that is\ninitialized with checked = true will be rendered as checked.",
+ "memberOf": ""
+ },
+ {
+ "name": "text",
+ "type": "String",
+ "desc": "The text to show on the menu item.",
+ "memberOf": "Roo.menu.Item"
+ },
+ {
+ "name": "HTML",
+ "type": "String",
+ "desc": "to render in menu\nThe text to show on the menu item (HTML version).",
+ "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"
+ },
+ {
+ "name": "canActivate",
+ "type": "Boolean",
+ "desc": "True if this item can be visually activated (defaults to true)",
+ "memberOf": "Roo.menu.Item"
+ },
+ {
+ "name": "showDelay",
+ "type": "Number",
+ "desc": "Length of time in milliseconds to wait before showing this item (defaults to 200)",
+ "memberOf": "Roo.menu.Item"
+ },
+ {
+ "name": "handler",
+ "type": "Function",
+ "desc": "A function that will handle the click event of this menu item (defaults to undefined)",
+ "memberOf": "Roo.menu.BaseItem"
+ },
+ {
+ "name": "activeClass",
+ "type": "String",
+ "desc": "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
+ "memberOf": "Roo.menu.BaseItem"
+ },
+ {
+ "name": "hideOnClick",
+ "type": "Boolean",
+ "desc": "True to hide the containing menu after this item is clicked (defaults to true)",
+ "memberOf": "Roo.menu.BaseItem"
+ },
+ {
+ "name": "hideDelay",
+ "type": "Number",
+ "desc": "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
+ "memberOf": "Roo.menu.BaseItem"
+ },
+ {
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "activate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this item is activated"
+ },
+ {
+ "name": "beforecheckchange",
+ "sig": "function (_self, checked)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the checked value is set, providing an opportunity to cancel if needed"
+ },
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "checkchange",
+ "sig": "function (_self, checked)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the checked value has been set"
+ },
+ {
+ "name": "click",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this item is clicked"
+ },
+ {
+ "name": "deactivate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this item is deactivated"
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ }
+ ]
+ },
+ "Roo.menu.ColorItem": {
+ "props": [
+ {
+ "name": "handler",
+ "type": "Function",
+ "desc": "A function that will handle the click event of this menu item (defaults to undefined)",
+ "memberOf": "Roo.menu.BaseItem"
+ },
+ {
+ "name": "canActivate",
+ "type": "Boolean",
+ "desc": "True if this item can be visually activated (defaults to false)",
+ "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"
+ },
+ {
+ "name": "hideOnClick",
+ "type": "Boolean",
+ "desc": "True to hide the containing menu after this item is clicked (defaults to true)",
+ "memberOf": "Roo.menu.BaseItem"
+ },
+ {
+ "name": "hideDelay",
+ "type": "Number",
+ "desc": "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
+ "memberOf": "Roo.menu.BaseItem"
+ },
+ {
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "activate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this item is activated"
+ },
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "click",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this item is clicked"
+ },
+ {
+ "name": "deactivate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this item is deactivated"
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ }
+ ]
+ },
+ "Roo.menu.ColorMenu": {
+ "props": [
+ {
+ "name": "minWidth",
+ "type": "Number",
+ "desc": "The minimum width of the menu in pixels (defaults to 120)",
+ "memberOf": "Roo.menu.Menu"
+ },
+ {
+ "name": "shadow",
+ "type": "Boolean/String",
+ "desc": "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")",
+ "memberOf": "Roo.menu.Menu"
+ },
+ {
+ "name": "subMenuAlign",
+ "type": "String",
+ "desc": "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")",
+ "memberOf": "Roo.menu.Menu"
+ },
+ {
+ "name": "defaultAlign",
+ "type": "String",
+ "desc": "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")",
+ "memberOf": "Roo.menu.Menu"
+ },
+ {
+ "name": "allowOtherMenus",
+ "type": "Boolean",
+ "desc": "True to allow multiple menus to be displayed at the same time (defaults to false)",
+ "memberOf": "Roo.menu.Menu"
+ },
+ {
+ "name": "registerMenu",
+ "type": "Boolean",
+ "desc": "True (default) - means that clicking on screen etc. hides it.",
+ "memberOf": "Roo.menu.Menu"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before this menu is hidden"
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before this menu is displayed"
+ },
+ {
+ "name": "click",
+ "sig": "function (_self, menuItem, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this menu is clicked (or when the enter key is pressed while it is active)"
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after this menu is hidden"
+ },
+ {
+ "name": "itemclick",
+ "sig": "function (baseItem, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a menu item contained in this menu is clicked"
+ },
+ {
+ "name": "mouseout",
+ "sig": "function (_self, e, menuItem)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the mouse exits this menu"
+ },
+ {
+ "name": "mouseover",
+ "sig": "function (_self, e, menuItem)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the mouse is hovering over this menu"
+ },
+ {
+ "name": "select",
+ "sig": "function (palette, color)\n{\n\n}",
+ "type": "function",
+ "desc": ""
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after this menu is displayed"
+ }
+ ]
+ },
+ "Roo.menu.DateItem": {
+ "props": [
+ {
+ "name": "handler",
+ "type": "Function",
+ "desc": "A function that will handle the click event of this menu item (defaults to undefined)",
+ "memberOf": "Roo.menu.BaseItem"
+ },
+ {
+ "name": "canActivate",
+ "type": "Boolean",
+ "desc": "True if this item can be visually activated (defaults to false)",
+ "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"
+ },
+ {
+ "name": "hideOnClick",
+ "type": "Boolean",
+ "desc": "True to hide the containing menu after this item is clicked (defaults to true)",
+ "memberOf": "Roo.menu.BaseItem"
+ },
+ {
+ "name": "hideDelay",
+ "type": "Number",
+ "desc": "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
+ "memberOf": "Roo.menu.BaseItem"
+ },
+ {
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "activate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this item is activated"
+ },
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "click",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this item is clicked"
+ },
+ {
+ "name": "deactivate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this item is deactivated"
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ }
+ ]
+ },
+ "Roo.menu.DateMenu": {
+ "props": [
+ {
+ "name": "minWidth",
+ "type": "Number",
+ "desc": "The minimum width of the menu in pixels (defaults to 120)",
+ "memberOf": "Roo.menu.Menu"
+ },
+ {
+ "name": "shadow",
+ "type": "Boolean/String",
+ "desc": "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")",
+ "memberOf": "Roo.menu.Menu"
+ },
+ {
+ "name": "subMenuAlign",
+ "type": "String",
+ "desc": "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")",
+ "memberOf": "Roo.menu.Menu"
+ },
+ {
+ "name": "defaultAlign",
+ "type": "String",
+ "desc": "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")",
+ "memberOf": "Roo.menu.Menu"
+ },
+ {
+ "name": "allowOtherMenus",
+ "type": "Boolean",
+ "desc": "True to allow multiple menus to be displayed at the same time (defaults to false)",
+ "memberOf": "Roo.menu.Menu"
+ },
+ {
+ "name": "registerMenu",
+ "type": "Boolean",
+ "desc": "True (default) - means that clicking on screen etc. hides it.",
+ "memberOf": "Roo.menu.Menu"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before this menu is hidden"
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before this menu is displayed"
+ },
+ {
+ "name": "click",
+ "sig": "function (_self, menuItem, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this menu is clicked (or when the enter key is pressed while it is active)"
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after this menu is hidden"
+ },
+ {
+ "name": "itemclick",
+ "sig": "function (baseItem, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a menu item contained in this menu is clicked"
+ },
+ {
+ "name": "mouseout",
+ "sig": "function (_self, e, menuItem)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the mouse exits this menu"
+ },
+ {
+ "name": "mouseover",
+ "sig": "function (_self, e, menuItem)\n{\n\n}",
"type": "function",
- "desc": "Fires before a cell is selected."
+ "desc": "Fires when the mouse is hovering over this menu"
},
{
- "name": "cellselect",
- "sig": "function (_self, rowIndex, colIndex)\n{\n\n}",
+ "name": "select",
+ "sig": "function (picker, date)\n{\n\n}",
"type": "function",
- "desc": "Fires when a cell is selected."
+ "desc": ""
},
{
- "name": "selectionchange",
- "sig": "function (_self, selection)\n{\n\n}",
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the active selection changes."
+ "desc": "Fires after this menu is displayed"
}
]
},
- "Roo.grid.ColumnModel": {
+ "Roo.menu.Item": {
"props": [
{
- "name": "header",
+ "name": "text",
"type": "String",
- "desc": "The header text to display in the Grid view.",
+ "desc": "The text to show on the menu item.",
"memberOf": ""
},
{
- "name": "dataIndex",
+ "name": "HTML",
"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.",
+ "desc": "to render in menu\nThe text to show on the menu item (HTML version).",
"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.",
+ "name": "icon",
+ "type": "String",
+ "desc": "The path to an icon to display in this menu item (defaults to Roo.BLANK_IMAGE_URL)",
"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}.",
+ "name": "itemCls",
+ "type": "String",
+ "desc": "The default CSS class to use for menu items (defaults to \"x-menu-item\")",
"memberOf": ""
},
{
- "name": "locked",
+ "name": "canActivate",
"type": "Boolean",
- "desc": "(Optional) True to lock the column in place while scrolling the Grid. Defaults to false.",
+ "desc": "True if this item can be visually activated (defaults to true)",
"memberOf": ""
},
{
- "name": "fixed",
- "type": "Boolean",
- "desc": "(Optional) True if the column width cannot be changed. Defaults to false.",
+ "name": "showDelay",
+ "type": "Number",
+ "desc": "Length of time in milliseconds to wait before showing this item (defaults to 200)",
"memberOf": ""
},
{
- "name": "resizable",
- "type": "Boolean",
- "desc": "(Optional) False to disable column resizing. Defaults to true.",
- "memberOf": ""
+ "name": "handler",
+ "type": "Function",
+ "desc": "A function that will handle the click event of this menu item (defaults to undefined)",
+ "memberOf": "Roo.menu.BaseItem"
},
{
- "name": "hidden",
+ "name": "activeClass",
+ "type": "String",
+ "desc": "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
+ "memberOf": "Roo.menu.BaseItem"
+ },
+ {
+ "name": "hideOnClick",
"type": "Boolean",
- "desc": "(Optional) True to hide the column. Defaults to false.",
- "memberOf": ""
+ "desc": "True to hide the containing menu after this item is clicked (defaults to true)",
+ "memberOf": "Roo.menu.BaseItem"
},
{
- "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 uses the raw data value.",
- "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"
},
{
- "name": "editor",
- "type": "Roo.grid.GridEditor",
- "desc": "(Optional) For grid editors - returns the grid editor",
- "memberOf": ""
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
},
{
- "name": "align",
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
"type": "String",
- "desc": "(Optional) Set the CSS text-align property of the column. Defaults to undefined.",
- "memberOf": ""
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
"events": [
{
- "name": "columlockchange",
- "sig": "function (_self, colIndex, locked)\n{\n\n}",
+ "name": "activate",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a column's locked state is changed"
+ "desc": "Fires when this item is activated"
},
{
- "name": "columnmoved",
- "sig": "function (_self, oldIndex, newIndex)\n{\n\n}",
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a column is moved."
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
},
{
- "name": "headerchange",
- "sig": "function (_self, columnIndex, newText)\n{\n\n}",
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the text of a header changes."
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
},
{
- "name": "hiddenchange",
- "sig": "function (_self, columnIndex, hidden)\n{\n\n}",
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a column is hidden or \"unhidden\"."
+ "desc": "Fires before the component is rendered. Return false to stop the render."
},
{
- "name": "widthchange",
- "sig": "function (_self, columnIndex, newWidth)\n{\n\n}",
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the width of a column changes."
- }
- ]
- },
- "Roo.grid.EditorGrid": {
- "props": [
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
{
- "name": "clicksToEdit",
- "type": "Number",
- "desc": "The number of clicks on a cell required to display the cell's editor (defaults to 2)",
- "memberOf": ""
- }
- ],
- "events": [
+ "name": "click",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this item is clicked"
+ },
{
- "name": "afteredit",
- "sig": "function (e)\n{\n\n}",
+ "name": "deactivate",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after a cell is edited. <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n</ul>"
+ "desc": "Fires when this item is deactivated"
},
{
- "name": "beforeedit",
- "sig": "function (e)\n{\n\n}",
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires before cell editing is triggered. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value for the field being edited.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>"
+ "desc": "Fires after the component is destroyed."
},
{
- "name": "validateedit",
- "sig": "function (e)\n{\n\n}",
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
"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 <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>editor - This editor</li>\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>"
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
}
]
},
- "Roo.grid.Grid": {
+ "Roo.menu.Menu": {
"props": [
{
- "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.",
+ "name": "minWidth",
+ "type": "Number",
+ "desc": "The minimum width of the menu in pixels (defaults to 120)",
"memberOf": ""
},
{
- "name": "maxHeight",
- "type": "Number",
- "desc": "Sets the maximum height of the grid - ignored if autoHeight is not on.",
+ "name": "shadow",
+ "type": "Boolean/String",
+ "desc": "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")",
"memberOf": ""
},
{
- "name": "minColumnWidth",
- "type": "Number",
- "desc": "The minimum width a column can be resized to. Default is 25.",
+ "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": ""
},
{
- "name": "autoSizeColumns",
+ "name": "defaultAlign",
+ "type": "String",
+ "desc": "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")",
+ "memberOf": ""
+ },
+ {
+ "name": "allowOtherMenus",
"type": "Boolean",
- "desc": "True to automatically resize the columns to fit their content\n<b>on initial render.</b> It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.",
+ "desc": "True to allow multiple menus to be displayed at the same time (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "registerMenu",
+ "type": "Boolean",
+ "desc": "True (default) - means that clicking on screen etc. hides it.",
"memberOf": ""
},
{
- "name": "autoSizeHeaders",
- "type": "Boolean",
- "desc": "True to measure headers with column data when auto sizing columns. Default is true.",
- "memberOf": ""
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before this menu is hidden"
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before this menu is displayed"
+ },
+ {
+ "name": "click",
+ "sig": "function (_self, menuItem, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this menu is clicked (or when the enter key is pressed while it is active)"
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after this menu is hidden"
+ },
+ {
+ "name": "itemclick",
+ "sig": "function (baseItem, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a menu item contained in this menu is clicked"
},
{
- "name": "monitorWindowResize",
- "type": "Boolean",
- "desc": "True to autoSize the grid when the window resizes. Default is true.",
- "memberOf": ""
+ "name": "mouseout",
+ "sig": "function (_self, e, menuItem)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the mouse exits this menu"
},
{
- "name": "maxRowsToMeasure",
- "type": "Boolean",
- "desc": "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
- "memberOf": ""
+ "name": "mouseover",
+ "sig": "function (_self, e, menuItem)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the mouse is hovering over this menu"
},
{
- "name": "trackMouseOver",
- "type": "Boolean",
- "desc": "True to highlight rows when the mouse is over. Default is true.",
- "memberOf": ""
- },
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after this menu is displayed"
+ }
+ ]
+ },
+ "Roo.menu.MenuMgr": {
+ "props": [],
+ "events": []
+ },
+ "Roo.menu.Separator": {
+ "props": [
{
- "name": "enableDragDrop",
- "type": "Boolean",
- "desc": "True to enable drag and drop of rows. Default is false.",
+ "name": "itemCls",
+ "type": "String",
+ "desc": "The default CSS class to use for separators (defaults to \"x-menu-sep\")",
"memberOf": ""
},
{
- "name": "enableColumnMove",
+ "name": "hideOnClick",
"type": "Boolean",
- "desc": "True to enable drag and drop reorder of columns. Default is true.",
+ "desc": "True to hide the containing menu after this item is clicked (defaults to false)",
"memberOf": ""
},
{
- "name": "enableColumnHide",
- "type": "Boolean",
- "desc": "True to enable hiding of columns with the header context menu. Default is true.",
- "memberOf": ""
+ "name": "handler",
+ "type": "Function",
+ "desc": "A function that will handle the click event of this menu item (defaults to undefined)",
+ "memberOf": "Roo.menu.BaseItem"
},
{
- "name": "enableRowHeightSync",
+ "name": "canActivate",
"type": "Boolean",
- "desc": "True to manually sync row heights across locked and not locked rows. Default is false.",
- "memberOf": ""
+ "desc": "True if this item can be visually activated (defaults to false)",
+ "memberOf": "Roo.menu.BaseItem"
},
{
- "name": "stripeRows",
- "type": "Boolean",
- "desc": "True to stripe the rows. Default is true.",
- "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"
},
{
- "name": "autoHeight",
- "type": "Boolean",
- "desc": "True to fit the height of the grid container to the height of the data. Default is false.",
- "memberOf": ""
+ "name": "hideDelay",
+ "type": "Number",
+ "desc": "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
+ "memberOf": "Roo.menu.BaseItem"
},
{
- "name": "autoExpandColumn",
+ "name": "disableClass",
"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": ""
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
},
{
- "name": "autoExpandMin",
- "type": "Number",
- "desc": "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
- "memberOf": ""
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
},
{
- "name": "autoExpandMax",
- "type": "Number",
- "desc": "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
- "memberOf": ""
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
},
{
- "name": "view",
- "type": "Object",
- "desc": "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().",
- "memberOf": ""
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
},
{
- "name": "loadMask",
+ "name": "listeners",
"type": "Object",
- "desc": "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
- "memberOf": ""
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
"events": [
{
- "name": "bodyscroll",
- "sig": "function (scrollLeft, scrollTop)\n{\n\n}",
+ "name": "activate",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the body element is scrolled"
+ "desc": "Fires when this item is activated"
},
{
- "name": "cellclick",
- "sig": "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a cell is clicked"
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
},
{
- "name": "cellcontextmenu",
- "sig": "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a cell is right clicked"
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
},
{
- "name": "celldblclick",
- "sig": "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a cell is double clicked"
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
},
{
"name": "click",
- "sig": "function (e)\n{\n\n}",
+ "sig": "function (_self, e)\n{\n\n}",
"type": "function",
- "desc": "The raw click event for the entire grid."
+ "desc": "Fires when this item is clicked"
},
{
- "name": "columnmove",
- "sig": "function (oldIndex, newIndex)\n{\n\n}",
+ "name": "deactivate",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the user moves a column"
+ "desc": "Fires when this item is deactivated"
},
{
- "name": "columnresize",
- "sig": "function (columnIndex, newSize)\n{\n\n}",
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the user resizes a column"
+ "desc": "Fires after the component is destroyed."
},
{
- "name": "contextmenu",
- "sig": "function (e)\n{\n\n}",
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "The raw contextmenu event for the entire grid."
+ "desc": "Fires after the component is disabled."
},
{
- "name": "dblclick",
- "sig": "function (e)\n{\n\n}",
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "The raw dblclick event for the entire grid."
+ "desc": "Fires after the component is enabled."
},
{
- "name": "dragdrop",
- "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when dragged row(s) are dropped on a valid DD target"
+ "desc": "Fires after the component is hidden."
},
{
- "name": "dragenter\n Fires when the dragged row(s) first cross another DD target while being dragged",
- "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": ""
+ "desc": "Fires after the component is rendered."
},
{
- "name": "dragout",
- "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the dragged row(s) leave another DD target while being dragged"
+ "desc": "Fires after the component is shown."
+ }
+ ]
+ },
+ "Roo.menu.TextItem": {
+ "props": [
+ {
+ "name": "text",
+ "type": "Boolean",
+ "desc": "Text to show on item.",
+ "memberOf": ""
},
{
- "name": "dragover",
- "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "name": "hideOnClick",
+ "type": "Boolean",
+ "desc": "True to hide the containing menu after this item is clicked (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "itemCls",
+ "type": "String",
+ "desc": "The default CSS class to use for text items (defaults to \"x-menu-text\")",
+ "memberOf": ""
+ },
+ {
+ "name": "handler",
+ "type": "Function",
+ "desc": "A function that will handle the click event of this menu item (defaults to undefined)",
+ "memberOf": "Roo.menu.BaseItem"
+ },
+ {
+ "name": "canActivate",
+ "type": "Boolean",
+ "desc": "True if this item can be visually activated (defaults to false)",
+ "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"
+ },
+ {
+ "name": "hideDelay",
+ "type": "Number",
+ "desc": "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
+ "memberOf": "Roo.menu.BaseItem"
+ },
+ {
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "activate",
+ "sig": "function (_self)\n{\n\n}",
"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."
+ "desc": "Fires when this item is activated"
},
{
- "name": "enddrag",
- "sig": "function (_self, dd, e)\n{\n\n}",
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a drag operation is complete"
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
},
{
- "name": "headerclick",
- "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a header is clicked"
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
},
{
- "name": "headercontextmenu",
- "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a header is right clicked"
+ "desc": "Fires before the component is rendered. Return false to stop the render."
},
{
- "name": "headerdblclick",
- "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a header cell is double clicked"
+ "desc": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "keydown",
- "sig": "function (e)\n{\n\n}",
+ "name": "click",
+ "sig": "function (_self, e)\n{\n\n}",
"type": "function",
- "desc": "The raw keydown event for the entire grid."
+ "desc": "Fires when this item is clicked"
},
{
- "name": "keypress",
- "sig": "function (e)\n{\n\n}",
+ "name": "deactivate",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "The raw keypress event for the entire grid."
+ "desc": "Fires when this item is deactivated"
},
{
- "name": "mousedown",
- "sig": "function (e)\n{\n\n}",
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "The raw mousedown event for the entire grid."
+ "desc": "Fires after the component is destroyed."
},
{
- "name": "mouseout",
- "sig": "function (e)\n{\n\n}",
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "The raw mouseout event for the entire grid."
+ "desc": "Fires after the component is disabled."
},
{
- "name": "mouseover",
- "sig": "function (e)\n{\n\n}",
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "The raw mouseover event for the entire grid."
+ "desc": "Fires after the component is enabled."
},
{
- "name": "mouseup",
- "sig": "function (e)\n{\n\n}",
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "The raw mouseup event for the entire grid."
+ "desc": "Fires after the component is hidden."
},
{
"name": "render",
- "sig": "function (grid)\n{\n\n}",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the grid is rendered"
+ "desc": "Fires after the component is rendered."
},
{
- "name": "rowclick",
- "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a row is clicked"
+ "desc": "Fires after the component is shown."
+ }
+ ]
+ },
+ "Roo.state": {
+ "props": [],
+ "events": []
+ },
+ "Roo.state.CookieProvider": {
+ "props": [
+ {
+ "name": "path",
+ "type": "String",
+ "desc": "The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site)",
+ "memberOf": ""
},
{
- "name": "rowcontextmenu",
- "sig": "function (_self, rowIndex, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a row is right clicked"
+ "name": "expires",
+ "type": "Date",
+ "desc": "The cookie expiration date (defaults to 7 days from now)",
+ "memberOf": ""
},
{
- "name": "rowdblclick",
- "sig": "function (_self, rowIndex, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a row is double clicked"
+ "name": "domain",
+ "type": "String",
+ "desc": "The domain to save the cookie for. Note that you cannot specify a different domain than\nyour page is on, but you can specify a sub-domain, or simply the domain itself like 'roojs.com' to include\nall sub-domains if you need to access cookies across different sub-domains (defaults to null which uses the same\ndomain the page is running on including the 'www' like 'www.roojs.com')",
+ "memberOf": ""
},
{
- "name": "startdrag",
- "sig": "function (_self, dd, e)\n{\n\n}",
+ "name": "secure",
+ "type": "Boolean",
+ "desc": "True if the site is using SSL (defaults to false)",
+ "memberOf": ""
+ }
+ ],
+ "events": [
+ {
+ "name": "statechange",
+ "sig": "function (_self, key, value)\n{\n\n}",
"type": "function",
- "desc": "Fires when row(s) start being dragged"
+ "desc": "Fires when a state change occurs."
}
]
},
- "Roo.grid.GridEditor": {
- "props": [
+ "Roo.state.Manager": {
+ "props": [],
+ "events": []
+ },
+ "Roo.state.Provider": {
+ "props": [],
+ "events": [
{
- "name": "field",
- "type": "Roo.form.Field",
- "desc": "Field to wrap (or xtyped)",
- "memberOf": ""
+ "name": "statechange",
+ "sig": "function (_self, key, value)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a state change occurs."
}
- ],
- "events": []
+ ]
},
- "Roo.grid.GridView": {
+ "Roo.tree": {
"props": [],
"events": []
},
- "Roo.grid.PropertyGrid": {
+ "Roo.tree.AsyncTreeNode": {
"props": [
{
- "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.",
+ "name": "loader",
+ "type": "TreeLoader",
+ "desc": "A TreeLoader to be used by this node (defaults to the loader defined on the tree)",
"memberOf": ""
},
{
- "name": "propertyNames",
+ "name": "text",
+ "type": "String",
+ "desc": "The text for this node",
+ "memberOf": "Roo.tree.TreeNode"
+ },
+ {
+ "name": "expanded",
+ "type": "Boolean",
+ "desc": "true to start the node expanded",
+ "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"
+ },
+ {
+ "name": "allowDrop",
+ "type": "Boolean",
+ "desc": "false if this node cannot be drop on",
+ "memberOf": "Roo.tree.TreeNode"
+ },
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "true to start the node disabled",
+ "memberOf": "Roo.tree.TreeNode"
+ },
+ {
+ "name": "icon",
+ "type": "String",
+ "desc": "The path to an icon for the node. The preferred way to do this",
+ "memberOf": "Roo.tree.TreeNode"
+ },
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "A css class to be added to the node",
+ "memberOf": "Roo.tree.TreeNode"
+ },
+ {
+ "name": "iconCls",
+ "type": "String",
+ "desc": "A css class to be added to the nodes icon element for applying css background images",
+ "memberOf": "Roo.tree.TreeNode"
+ },
+ {
+ "name": "href",
+ "type": "String",
+ "desc": "URL of the link used for the node (defaults to #)",
+ "memberOf": "Roo.tree.TreeNode"
+ },
+ {
+ "name": "hrefTarget",
+ "type": "String",
+ "desc": "target frame for the link",
+ "memberOf": "Roo.tree.TreeNode"
+ },
+ {
+ "name": "qtip",
+ "type": "String",
+ "desc": "An Ext QuickTip for the node",
+ "memberOf": "Roo.tree.TreeNode"
+ },
+ {
+ "name": "qtipCfg",
+ "type": "String",
+ "desc": "An Ext QuickTip config for the node (used instead of qtip)",
+ "memberOf": "Roo.tree.TreeNode"
+ },
+ {
+ "name": "singleClickExpand",
+ "type": "Boolean",
+ "desc": "True for single click expand on this node",
+ "memberOf": "Roo.tree.TreeNode"
+ },
+ {
+ "name": "uiProvider",
+ "type": "Function",
+ "desc": "A UI <b>class</b> to use for this node (defaults to Roo.tree.TreeNodeUI)",
+ "memberOf": "Roo.tree.TreeNode"
+ },
+ {
+ "name": "checked",
+ "type": "Boolean",
+ "desc": "True to render a checked checkbox for this node, false to render an unchecked checkbox\n(defaults to undefined with no checkbox rendered)",
+ "memberOf": "Roo.tree.TreeNode"
+ },
+ {
+ "name": "leaf",
+ "type": "Boolean",
+ "desc": "true if this node is a leaf and does not have children",
+ "memberOf": "Roo.data.Node"
+ },
+ {
+ "name": "id",
+ "type": "String",
+ "desc": "The id for this node. If one is not specified, one is generated.",
+ "memberOf": "Roo.data.Node"
+ },
+ {
+ "name": "listeners",
"type": "Object",
- "desc": "map of property Names to their displayed value",
- "memberOf": ""
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
"events": [
{
- "name": "beforepropertychange",
- "sig": "function (grid, id, newval, oldval)\n{\n\n}",
+ "name": "append",
+ "sig": "function (tree, _self, node, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a new child node is appended"
+ },
+ {
+ "name": "beforeappend",
+ "sig": "function (tree, _self, node)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a new child is appended, return false to cancel the append."
+ },
+ {
+ "name": "beforechildrenrendered",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires right before the child nodes for this node are rendered"
+ },
+ {
+ "name": "beforeclick",
+ "sig": "function (_self, e)\n{\n\n}",
"type": "function",
- "desc": "Fires before a property changes (return false to stop?)"
+ "desc": "Fires before click processing. Return false to cancel the default action."
},
{
- "name": "propertychange",
- "sig": "function (grid, id, newval, oldval)\n{\n\n}",
+ "name": "beforecollapse",
+ "sig": "function (_self, deep, anim)\n{\n\n}",
"type": "function",
- "desc": "Fires after a property changes"
- }
- ]
- },
- "Roo.grid.RowSelectionModel": {
- "props": [
+ "desc": "Fires before this node is collapsed, return false to cancel."
+ },
{
- "name": "singleSelect",
- "type": "Boolean",
- "desc": "True to allow selection of only one row at a time (defaults to false)",
- "memberOf": ""
- }
- ],
- "events": [
+ "name": "beforeexpand",
+ "sig": "function (_self, deep, anim)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before this node is expanded, return false to cancel."
+ },
{
- "name": "afterselectionchange",
+ "name": "beforeinsert",
+ "sig": "function (tree, _self, node, refNode)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a new child is inserted, return false to cancel the insert."
+ },
+ {
+ "name": "beforeload",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the selection changes (eg. by key press or clicking)"
+ "desc": "Fires before this node is loaded, return false to cancel"
},
{
- "name": "beforerowselect",
- "sig": "function (_self, rowIndex, keepExisting)\n{\n\n}",
+ "name": "beforemove",
+ "sig": "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
"type": "function",
- "desc": "Fires when a row is selected being selected, return false to cancel."
+ "desc": "Fires before this node is moved to a new location in the tree. Return false to cancel the move."
},
{
- "name": "rowdeselect",
- "sig": "function (_self, rowIndex)\n{\n\n}",
+ "name": "beforeremove",
+ "sig": "function (tree, _self, node)\n{\n\n}",
"type": "function",
- "desc": "Fires when a row is deselected."
+ "desc": "Fires before a child is removed, return false to cancel the remove."
},
{
- "name": "rowselect",
- "sig": "function (_self, rowIndex, r)\n{\n\n}",
+ "name": "checkchange",
+ "sig": "function (_self, checked)\n{\n\n}",
"type": "function",
- "desc": "Fires when a row is selected."
+ "desc": "Fires when a node with a checkbox's checked property changes"
},
{
- "name": "selectionchange",
+ "name": "click",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this node is clicked"
+ },
+ {
+ "name": "collapse",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the selection changes"
- }
- ]
- },
- "Roo.menu": {
- "props": [],
- "events": []
- },
- "Roo.menu.Adapter": {
- "props": [],
- "events": []
- },
- "Roo.menu.BaseItem": {
- "props": [
+ "desc": "Fires when this node is collapsed"
+ },
{
- "name": "handler",
- "type": "Function",
- "desc": "A function that will handle the click event of this menu item (defaults to undefined)",
- "memberOf": ""
+ "name": "contextmenu",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this node is right clicked"
},
{
- "name": "canActivate",
- "type": "Boolean",
- "desc": "True if this item can be visually activated (defaults to false)",
- "memberOf": ""
+ "name": "dblclick",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this node is double clicked"
},
{
- "name": "activeClass",
- "type": "String",
- "desc": "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
- "memberOf": ""
+ "name": "disabledchange",
+ "sig": "function (_self, disabled)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the disabled status of this node changes"
},
{
- "name": "hideOnClick",
- "type": "Boolean",
- "desc": "True to hide the containing menu after this item is clicked (defaults to true)",
- "memberOf": ""
+ "name": "expand",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this node is expanded"
},
{
- "name": "hideDelay",
- "type": "Number",
- "desc": "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
- "memberOf": ""
- }
- ],
- "events": [
+ "name": "insert",
+ "sig": "function (tree, _self, node, refNode)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a new child node is inserted."
+ },
{
- "name": "activate",
+ "name": "load",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when this item is activated"
+ "desc": "Fires when this node is loaded"
},
{
- "name": "click",
- "sig": "function (_self, e)\n{\n\n}",
+ "name": "move",
+ "sig": "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
"type": "function",
- "desc": "Fires when this item is clicked"
+ "desc": "Fires when this node is moved to a new location in the tree"
},
{
- "name": "deactivate",
- "sig": "function (_self)\n{\n\n}",
+ "name": "remove",
+ "sig": "function (tree, _self, node)\n{\n\n}",
"type": "function",
- "desc": "Fires when this item is deactivated"
+ "desc": "Fires when a child node is removed"
+ },
+ {
+ "name": "textchange",
+ "sig": "function (_self, text, oldText)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the text for this node is changed"
}
]
},
- "Roo.menu.CheckItem": {
+ "Roo.tree.ColumnTree": {
"props": [
{
- "name": "group",
- "type": "String",
- "desc": "All check items with the same group name will automatically be grouped into a single-select\nradio button group (defaults to '')",
- "memberOf": ""
- },
- {
- "name": "itemCls",
- "type": "String",
- "desc": "The default CSS class to use for check items (defaults to \"x-menu-item x-menu-check-item\")",
- "memberOf": ""
- },
- {
- "name": "groupClass",
- "type": "String",
- "desc": "The default CSS class to use for radio group check items (defaults to \"x-menu-group-item\")",
+ "name": "columns",
+ "type": "Object",
+ "desc": "Including width, header, renderer, cls, dataIndex",
"memberOf": ""
},
{
- "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.",
+ "name": "borderWidth",
+ "type": "int",
+ "desc": "compined right/left border allowance",
"memberOf": ""
}
],
"events": [
{
- "name": "beforecheckchange",
- "sig": "function (_self, checked)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the checked value is set, providing an opportunity to cancel if needed"
- },
- {
- "name": "checkchange",
- "sig": "function (_self, checked)\n{\n\n}",
+ "name": "resize",
+ "sig": "function (w, h)\n{\n\n}",
"type": "function",
- "desc": "Fires after the checked value has been set"
+ "desc": "Fire this event on a container when it resizes"
}
]
},
- "Roo.menu.ColorItem": {
- "props": [],
- "events": []
- },
- "Roo.menu.ColorMenu": {
- "props": [],
- "events": [
+ "Roo.tree.DefaultSelectionModel": {
+ "props": [
{
- "name": "select",
- "sig": "function (palette, color)\n{\n\n}",
- "type": "function",
- "desc": ""
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
- ]
- },
- "Roo.menu.DateItem": {
- "props": [],
- "events": []
- },
- "Roo.menu.DateMenu": {
- "props": [],
+ ],
"events": [
{
- "name": "select",
- "sig": "function (picker, date)\n{\n\n}",
+ "name": "beforeselect",
+ "sig": "function (_self, node, node)\n{\n\n}",
"type": "function",
- "desc": ""
+ "desc": "Fires before the selected node changes, return false to cancel the change"
+ },
+ {
+ "name": "selectionchange",
+ "sig": "function (_self, node)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the selected node changes"
}
]
},
- "Roo.menu.Item": {
+ "Roo.tree.MultiSelectionModel": {
"props": [
{
- "name": "icon",
- "type": "String",
- "desc": "The path to an icon to display in this menu item (defaults to Roo.BLANK_IMAGE_URL)",
- "memberOf": ""
- },
- {
- "name": "itemCls",
- "type": "String",
- "desc": "The default CSS class to use for menu items (defaults to \"x-menu-item\")",
- "memberOf": ""
- },
- {
- "name": "canActivate",
- "type": "Boolean",
- "desc": "True if this item can be visually activated (defaults to true)",
- "memberOf": ""
- },
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
{
- "name": "showDelay",
- "type": "Number",
- "desc": "Length of time in milliseconds to wait before showing this item (defaults to 200)",
- "memberOf": ""
+ "name": "selectionchange",
+ "sig": "function (_self, nodes)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the selected nodes change"
}
- ],
- "events": []
+ ]
},
- "Roo.menu.Menu": {
+ "Roo.tree.TreeEditor": {
"props": [
{
- "name": "minWidth",
- "type": "Number",
- "desc": "The minimum width of the menu in pixels (defaults to 120)",
+ "name": "tree",
+ "type": "Roo.tree.TreePanel",
+ "desc": "The tree to bind to.",
"memberOf": ""
},
{
- "name": "shadow",
- "type": "Boolean/String",
- "desc": "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")",
+ "name": "field",
+ "type": "Roo.form.TextField|Object",
+ "desc": "The field configuration",
"memberOf": ""
},
{
- "name": "subMenuAlign",
+ "name": "alignment",
"type": "String",
- "desc": "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")",
+ "desc": "The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to \"l-l\").",
"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?\")",
+ "name": "hideEl",
+ "type": "Boolean",
+ "desc": "True to hide the bound element while the editor is displayed (defaults to false)",
"memberOf": ""
},
{
- "name": "allowOtherMenus",
- "type": "Boolean",
- "desc": "True to allow multiple menus to be displayed at the same time (defaults to false)",
+ "name": "cls",
+ "type": "String",
+ "desc": "CSS class to apply to the editor (defaults to \"x-small-editor x-tree-editor\")",
"memberOf": ""
},
{
- "name": "registerMenu",
+ "name": "shim",
"type": "Boolean",
- "desc": "True (default) - means that clicking on screen etc. hides it.",
+ "desc": "True to shim the editor if selects/iframes could be displayed beneath it (defaults to false)",
"memberOf": ""
- }
- ],
- "events": [
- {
- "name": "beforehide",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires before this menu is hidden"
},
{
- "name": "beforeshow",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires before this menu is displayed"
+ "name": "maxWidth",
+ "type": "Number",
+ "desc": "The maximum width in pixels of the editor field (defaults to 250). Note that if the maxWidth would exceed\nthe containing tree element's size, it will be automatically limited for you to the container width, taking\nscroll and client offsets into account prior to each edit.",
+ "memberOf": ""
},
{
- "name": "click",
- "sig": "function (_self, menuItem, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this menu is clicked (or when the enter key is pressed while it is active)"
+ "name": "autosize",
+ "type": "Boolean/String",
+ "desc": "True for the editor to automatically adopt the size of the underlying field, \"width\" to adopt the width only,\nor \"height\" to adopt the height only (defaults to false)",
+ "memberOf": "Roo.Editor"
},
{
- "name": "hide",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after this menu is hidden"
+ "name": "revertInvalid",
+ "type": "Boolean",
+ "desc": "True to automatically revert the field value and cancel the edit when the user completes an edit and the field\nvalidation fails (defaults to true)",
+ "memberOf": "Roo.Editor"
},
{
- "name": "itemclick",
- "sig": "function (baseItem, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a menu item contained in this menu is clicked"
+ "name": "ignoreNoChange",
+ "type": "Boolean",
+ "desc": "True to skip the the edit completion process (no save, no events fired) if the user completes an edit and\nthe value has not changed (defaults to false). Applies only to string values - edits for other data types\nwill never be ignored.",
+ "memberOf": "Roo.Editor"
},
{
- "name": "mouseout",
- "sig": "function (_self, e, menuItem)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the mouse exits this menu"
+ "name": "value",
+ "type": "Mixed",
+ "desc": "The data value of the underlying field (defaults to \"\")",
+ "memberOf": "Roo.Editor"
},
{
- "name": "mouseover",
- "sig": "function (_self, e, menuItem)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the mouse is hovering over this menu"
+ "name": "shadow",
+ "type": "Boolean/String",
+ "desc": "\"sides\" for sides/bottom only, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"frame\")",
+ "memberOf": "Roo.Editor"
},
{
- "name": "show",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after this menu is displayed"
- }
- ]
- },
- "Roo.menu.MenuMgr": {
- "props": [],
- "events": []
- },
- "Roo.menu.Separator": {
- "props": [
+ "name": "constrain",
+ "type": "Boolean",
+ "desc": "True to constrain the editor to the viewport",
+ "memberOf": "Roo.Editor"
+ },
{
- "name": "itemCls",
- "type": "String",
- "desc": "The default CSS class to use for separators (defaults to \"x-menu-sep\")",
- "memberOf": ""
+ "name": "completeOnEnter",
+ "type": "Boolean",
+ "desc": "True to complete the edit when the enter key is pressed (defaults to false)",
+ "memberOf": "Roo.Editor"
},
{
- "name": "hideOnClick",
+ "name": "cancelOnEsc",
"type": "Boolean",
- "desc": "True to hide the containing menu after this item is clicked (defaults to false)",
- "memberOf": ""
- }
- ],
- "events": []
- },
- "Roo.menu.TextItem": {
- "props": [
+ "desc": "True to cancel the edit when the escape key is pressed (defaults to false)",
+ "memberOf": "Roo.Editor"
+ },
{
- "name": "hideOnClick",
+ "name": "updateEl",
"type": "Boolean",
- "desc": "True to hide the containing menu after this item is clicked (defaults to false)",
- "memberOf": ""
+ "desc": "True to update the innerHTML of the bound element when the update completes (defaults to false)",
+ "memberOf": "Roo.Editor"
},
{
- "name": "itemCls",
+ "name": "disableClass",
"type": "String",
- "desc": "The default CSS class to use for text items (defaults to \"x-menu-text\")",
- "memberOf": ""
- }
- ],
- "events": []
- },
- "Roo.state": {
- "props": [],
- "events": []
- },
- "Roo.state.CookieProvider": {
- "props": [
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
{
- "name": "path",
- "type": "String",
- "desc": "The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site)",
- "memberOf": ""
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
},
{
- "name": "expires",
- "type": "Date",
- "desc": "The cookie expiration date (defaults to 7 days from now)",
- "memberOf": ""
+ "name": "hideMode",
+ "type": "String",
+ "desc": "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf": "Roo.Component"
},
{
- "name": "domain",
+ "name": "actionMode",
"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": ""
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
},
{
- "name": "secure",
- "type": "Boolean",
- "desc": "True if the site is using SSL (defaults to false)",
- "memberOf": ""
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
- "events": []
- },
- "Roo.state.Manager": {
- "props": [],
- "events": []
- },
- "Roo.state.Provider": {
- "props": [],
"events": [
{
- "name": "statechange",
- "sig": "function (_self, key, value)\n{\n\n}",
+ "name": "beforecomplete",
+ "sig": "function (_self, value, startValue)\n{\n\n}",
"type": "function",
- "desc": "Fires when a state change occurs."
- }
- ]
- },
- "Roo.tree": {
- "props": [],
- "events": []
- },
- "Roo.tree.AsyncTreeNode": {
- "props": [
- {
- "name": "loader",
- "type": "TreeLoader",
- "desc": "A TreeLoader to be used by this node (defaults to the loader defined on the tree)",
- "memberOf": ""
- }
- ],
- "events": [
+ "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."
+ },
{
- "name": "beforeload",
+ "name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires before this node is loaded, return false to cancel"
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
},
{
- "name": "load",
+ "name": "beforehide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when this node is loaded"
- }
- ]
- },
- "Roo.tree.ColumnTree": {
- "props": [
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
{
- "name": "columns",
- "type": "Object",
- "desc": "Including width, header, renderer, cls, dataIndex",
- "memberOf": ""
+ "name": "beforenodeedit",
+ "sig": "function (_self, node)\n{\n\n}",
+ "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."
},
{
- "name": "borderWidth",
- "type": "int",
- "desc": "compined right/left border allowance",
- "memberOf": ""
- }
- ],
- "events": [
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
{
- "name": "resize",
- "sig": "function (w, h)\n{\n\n}",
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fire this event on a container when it resizes"
- }
- ]
- },
- "Roo.tree.DefaultSelectionModel": {
- "props": [],
- "events": [
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "beforestartedit",
+ "sig": "function (_self, boundEl, value)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "complete",
+ "sig": "function (_self, value, startValue)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after editing is complete and any changed value has been written to the underlying field."
+ },
{
- "name": "beforeselect",
- "sig": "function (_self, node, node)\n{\n\n}",
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires before the selected node changes, return false to cancel the change"
+ "desc": "Fires after the component is destroyed."
},
{
- "name": "selectionchange",
- "sig": "function (_self, node)\n{\n\n}",
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the selected node changes"
- }
- ]
- },
- "Roo.tree.MultiSelectionModel": {
- "props": [],
- "events": [
+ "desc": "Fires after the component is disabled."
+ },
{
- "name": "selectionchange",
- "sig": "function (_self, nodes)\n{\n\n}",
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the selected nodes change"
- }
- ]
- },
- "Roo.tree.TreeEditor": {
- "props": [
+ "desc": "Fires after the component is enabled."
+ },
{
- "name": "alignment",
- "type": "String",
- "desc": "The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to \"l-l\").",
- "memberOf": ""
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
},
{
- "name": "hideEl",
- "type": "Boolean",
- "desc": "True to hide the bound element while the editor is displayed (defaults to false)",
- "memberOf": ""
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
},
{
- "name": "cls",
- "type": "String",
- "desc": "CSS class to apply to the editor (defaults to \"x-small-editor x-tree-editor\")",
- "memberOf": ""
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
},
{
- "name": "shim",
- "type": "Boolean",
- "desc": "True to shim the editor if selects/iframes could be displayed beneath it (defaults to false)",
- "memberOf": ""
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
+ "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."
},
{
- "name": "maxWidth",
- "type": "Number",
- "desc": "The maximum width in pixels of the editor field (defaults to 250). Note that if the maxWidth would exceed\nthe containing tree element's size, it will be automatically limited for you to the container width, taking\nscroll and client offsets into account prior to each edit.",
- "memberOf": ""
+ "name": "startedit",
+ "sig": "function (boundEl, value)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this editor is displayed"
}
- ],
- "events": []
+ ]
},
"Roo.tree.TreeFilter": {
"props": [],
{
"name": "uiProviders",
"type": "Object",
- "desc": "(optional) An object containing properties which\n\nDEPRECIATED - use 'create' event handler to modify attributes - which affect creation.\nspecify custom {@link Roo.tree.TreeNodeUI} implementations. If the optional\n<i>uiProvider</i> 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)",
+ "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\n<i>uiProvider</i> 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": ""
},
{
"type": "String",
"desc": "(optional) \nName of the query as it will be passed on the querystring (defaults to 'node')\neg. the request will be ?node=[id]",
"memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
"events": [
"type": "Boolean",
"desc": "True to render a checked checkbox for this node, false to render an unchecked checkbox\n(defaults to undefined with no checkbox rendered)",
"memberOf": ""
+ },
+ {
+ "name": "leaf",
+ "type": "Boolean",
+ "desc": "true if this node is a leaf and does not have children",
+ "memberOf": "Roo.data.Node"
+ },
+ {
+ "name": "id",
+ "type": "String",
+ "desc": "The id for this node. If one is not specified, one is generated.",
+ "memberOf": "Roo.data.Node"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
"events": [
+ {
+ "name": "append",
+ "sig": "function (tree, _self, node, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a new child node is appended"
+ },
+ {
+ "name": "beforeappend",
+ "sig": "function (tree, _self, node)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a new child is appended, return false to cancel the append."
+ },
{
"name": "beforechildrenrendered",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires before this node is expanded, return false to cancel."
},
+ {
+ "name": "beforeinsert",
+ "sig": "function (tree, _self, node, refNode)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a new child is inserted, return false to cancel the insert."
+ },
+ {
+ "name": "beforemove",
+ "sig": "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before this node is moved to a new location in the tree. Return false to cancel the move."
+ },
+ {
+ "name": "beforeremove",
+ "sig": "function (tree, _self, node)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a child is removed, return false to cancel the remove."
+ },
{
"name": "checkchange",
"sig": "function (_self, checked)\n{\n\n}",
"type": "function",
"desc": "Fires when this node is expanded"
},
+ {
+ "name": "insert",
+ "sig": "function (tree, _self, node, refNode)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a new child node is inserted."
+ },
+ {
+ "name": "move",
+ "sig": "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this node is moved to a new location in the tree"
+ },
+ {
+ "name": "remove",
+ "sig": "function (tree, _self, node)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a child node is removed"
+ },
{
"name": "textchange",
"sig": "function (_self, text, oldText)\n{\n\n}",
"desc": "A TreeLoader for use with this TreePanel",
"memberOf": ""
},
+ {
+ "name": "editor",
+ "type": "Object|Roo.tree.TreeEditor",
+ "desc": "The TreeEditor or xtype data to display when clicked.",
+ "memberOf": ""
+ },
{
"name": "pathSeparator",
"type": "String",
{
"name": "renderer",
"type": "Function",
- "desc": "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>",
+ "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:<ul><li>The {Object} The data for the node.</li></ul>",
"memberOf": ""
},
{
"name": "rendererTip",
"type": "Function",
- "desc": "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>",
+ "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:<ul><li>The {Object} The data for the node.</li></ul>",
"memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
"events": [
+ {
+ "name": "append",
+ "sig": "function (tree, parent, node, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a new child node is appended to a node in this tree."
+ },
+ {
+ "name": "beforeappend",
+ "sig": "function (tree, parent, node)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a new child is appended to a node in this tree, return false to cancel the append."
+ },
{
"name": "beforechildrenrendered",
"sig": "function (node)\n{\n\n}",
"type": "function",
"desc": "Fires before a node is expanded, return false to cancel."
},
+ {
+ "name": "beforeinsert",
+ "sig": "function (tree, parent, node, refNode)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a new child is inserted in a node in this tree, return false to cancel the insert."
+ },
{
"name": "beforeload",
"sig": "function (node)\n{\n\n}",
"type": "function",
"desc": "Fires before a node is loaded, return false to cancel"
},
+ {
+ "name": "beforemove",
+ "sig": "function (tree, node, oldParent, newParent, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a node is moved to a new location in the tree. Return false to cancel the move."
+ },
{
"name": "beforenodedrop",
"sig": "function (dropEvent)\n{\n\n}",
"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:<br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>tree - The TreePanel</li>\n<li>target - The node being targeted for the drop</li>\n<li>data - The drag data from the drag source</li>\n<li>point - The point of the drop - append, above or below</li>\n<li>source - The drag source</li>\n<li>rawEvent - Raw mouse event</li>\n<li>dropNode - Drop node(s) provided by the source <b>OR</b> you can supply node(s)\nto be inserted by setting them on this object.</li>\n<li>cancel - Set this to true to cancel the drop.</li>\n</ul>"
},
+ {
+ "name": "beforeremove",
+ "sig": "function (tree, parent, node)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a child is removed from a node in this tree, return false to cancel the remove."
+ },
{
"name": "checkchange",
"sig": "function (_self, checked)\n{\n\n}",
"type": "function",
"desc": "Fires when a node is expanded"
},
+ {
+ "name": "insert",
+ "sig": "function (tree, parent, node, refNode)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a new child node is inserted in a node in this tree."
+ },
{
"name": "load",
"sig": "function (node)\n{\n\n}",
"type": "function",
"desc": "Fires when a node is loaded"
},
+ {
+ "name": "move",
+ "sig": "function (tree, node, oldParent, newParent, index)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a node is moved to a new location in the tree"
+ },
{
"name": "nodedragover",
"sig": "function (dragOverEvent)\n{\n\n}",
"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:<br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>tree - The TreePanel</li>\n<li>target - The node being targeted for the drop</li>\n<li>data - The drag data from the drag source</li>\n<li>point - The point of the drop - append, above or below</li>\n<li>source - The drag source</li>\n<li>rawEvent - Raw mouse event</li>\n<li>dropNode - Dropped node(s).</li>\n</ul>"
},
+ {
+ "name": "remove",
+ "sig": "function (tree, parent, node)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a child node is removed from a node in this tree."
+ },
{
"name": "startdrag",
"sig": "function (_self, node, e)\n{\n\n}",
"type": "Boolean",
"desc": "True to stop the default click event",
"memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
}
],
"events": [
"props": [],
"events": []
},
- "Roo.util.MixedCollection": {
+ "Roo.util.Math": {
"props": [],
+ "events": []
+ },
+ "Roo.util.MixedCollection": {
+ "props": [
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
"events": [
{
"name": "add",
"props": [],
"events": []
},
- "String": {
+ "Roo.util.TextMetrics.Instance": {
"props": [],
"events": []
},
- "_global_": {
- "props": [
- {
- "name": "disabled",
- "type": "Function|boolean",
- "desc": "If this module is disabled by some rule, return true from the funtion",
- "memberOf": ""
- },
- {
- "name": "parent",
- "type": "String",
- "desc": "Name of parent element which it get xtype added to..",
- "memberOf": ""
- },
- {
- "name": "order",
- "type": "String",
- "desc": "Used to set the order in which elements are created (usefull for multiple tabs)",
- "memberOf": ""
- },
- {
- "name": "name",
- "type": "String",
- "desc": "String to display while loading.",
- "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": ""
- }
- ],
- "events": []
- },
- "ep": {
+ "String": {
"props": [],
"events": []
},
- "instance": {
+ "_global_": {
"props": [],
"events": []
},
projects / roojs1 / blobdiff